> ## Documentation Index
> Fetch the complete documentation index at: https://docs.replo.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Change shipping settings

> **Beta** — this endpoint may change before general availability.



## OpenAPI

````yaml /api-reference/openapi.json patch /shipping/settings
openapi: 3.1.0
info:
  title: Replo Public API
  version: '2026-11-17'
servers:
  - url: https://api.replo.app/v1
security: []
paths:
  /shipping/settings:
    patch:
      tags:
        - Shipping-settings
      summary: Change shipping settings
      description: '**Beta** — this endpoint may change before general availability.'
      operationId: shippingSettings.update
      parameters:
        - name: Replo-Api-Version
          in: header
          required: true
          schema:
            type: string
            enum:
              - '2026-11-17'
          description: The public API version to use for this request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  format: uuid
                  description: Project whose shipping settings to change.
                labelFormat:
                  type: string
                  enum:
                    - pdf4x6
                    - pdfLetter
                handlingDays:
                  type: integer
                  minimum: 0
                  maximum: 30
                defaultItemWeightGrams:
                  type:
                    - integer
                    - 'null'
                  exclusiveMinimum: 0
                  maximum: 70000
                customsSigner:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 255
                defaultContentsType:
                  type: string
                  enum:
                    - merchandise
                    - gift
                    - sample
                    - documents
                    - returnedGoods
                eelPfc:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 64
                shippedEmailTiming:
                  type: string
                  enum:
                    - firstScan
                    - immediate
                shippingMethod:
                  type:
                    - string
                    - 'null'
                  enum:
                    - reploLabel
                    - shipstation
                    - csv
                    - manual
                    - null
                  description: ShippingMethod
              required:
                - projectId
              additionalProperties: false
      responses:
        '200':
          description: Change shipping settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingSettings'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/InvalidCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
components:
  schemas:
    ShippingSettings:
      type: object
      properties:
        labelFormat:
          type: string
          enum:
            - pdf4x6
            - pdfLetter
        handlingDays:
          type: integer
          minimum: 0
          maximum: 30
        defaultItemWeightGrams:
          type:
            - integer
            - 'null'
          exclusiveMinimum: 0
          maximum: 70000
        customsSigner:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 255
        defaultContentsType:
          type: string
          enum:
            - merchandise
            - gift
            - sample
            - documents
            - returnedGoods
        eelPfc:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 64
        shippedEmailTiming:
          type: string
          enum:
            - firstScan
            - immediate
        shippingMethod:
          type:
            - string
            - 'null'
          enum:
            - reploLabel
            - shipstation
            - csv
            - manual
            - null
          description: ShippingMethod
        object:
          type: string
          enum:
            - shipping_settings
        projectId:
          type: string
          format: uuid
      required:
        - labelFormat
        - handlingDays
        - defaultItemWeightGrams
        - customsSigner
        - defaultContentsType
        - eelPfc
        - shippedEmailTiming
        - shippingMethod
        - object
        - projectId
    PublicApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            doc_url:
              type: string
            issues:
              type: array
              items:
                type: object
                properties:
                  param:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Dotted path to the failing field within the request body,
                      query or path, e.g. "name" or "variants.0.available"; null
                      when the rule covers the whole input.
                  message:
                    type: string
                    description: Why the field was rejected.
                required:
                  - param
                  - message
              description: >-
                Present on an invalid_request whose input failed validation:
                each failing field and why, at most 10.
          required:
            - code
            - message
            - doc_url
      required:
        - error
  responses:
    InvalidRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    InvalidCredentials:
      description: >-
        Missing or invalid Replo Public API token. Send an active key as
        `Authorization: Bearer replo_sk_...`; if it was revoked, create a new
        key in Replo Settings.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    Forbidden:
      description: >-
        You are not authorized to access this resource. Ask a workspace owner to
        perform this action or to grant the key's creator access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    NotFound:
      description: >-
        Not Found. The resource may not exist, this key may lack the required
        scope, or the key's creator may have lost access. Check the key's scopes
        in Replo Settings and the creator's project or workspace access; a
        workspace owner can grant access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    Conflict:
      description: The resource is in a conflicting state.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    PayloadTooLarge:
      description: File content exceeds the 10 MiB limit.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    RateLimitExceeded:
      description: >-
        Too many requests. Please retry after the time indicated by the
        Retry-After header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    InternalError:
      description: An internal error occurred.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    ServiceUnavailable:
      description: Service temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.