> ## 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.

# Mark an order shipped

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



## OpenAPI

````yaml /api-reference/openapi.json post /orders/{orderId}/fulfillments
openapi: 3.1.0
info:
  title: Replo Public API
  version: '2026-11-17'
servers:
  - url: https://api.replo.app/v1
security: []
paths:
  /orders/{orderId}/fulfillments:
    post:
      tags:
        - Orders
      summary: Mark an order shipped
      description: '**Beta** — this endpoint may change before general availability.'
      operationId: orders.fulfillments.create
      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.
        - schema:
            type: string
            format: uuid
            description: ID of the order whose packages to list.
          required: true
          description: ID of the order whose packages to list.
          name: orderId
          in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                trackingNumber:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 255
                  description: The carrier's tracking number.
                trackingCarrier:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 255
                  description: The carrier, e.g. "USPS", "UPS", "FedEx" or "DHL".
                trackingUrl:
                  type:
                    - string
                    - 'null'
                  maxLength: 2048
                  format: uri
                  description: >-
                    A tracking page. Leave it out and Replo links the carrier's
                    own page when it knows the carrier.
                items:
                  type:
                    - array
                    - 'null'
                  items:
                    type: object
                    properties:
                      orderItemId:
                        type: string
                        format: uuid
                        description: An item on the order.
                      quantity:
                        type: integer
                        exclusiveMinimum: 0
                        description: How many of it shipped. Omit for all that remain.
                    required:
                      - orderItemId
                  minItems: 1
                  maxItems: 250
                  description: >-
                    Items in this package. Omit for everything the merchant has
                    not shipped yet.
                notifyBuyer:
                  type: boolean
                  description: >-
                    Whether Replo emails the buyer that the order shipped.
                    Defaults to true. When the store's Replo Shipping account
                    tracks the package, the email waits for the carrier's first
                    scan (at most 24 hours); otherwise it goes out right away.
                    False never emails the buyer about this package.
              additionalProperties: false
      responses:
        '201':
          description: Mark an order shipped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fulfillment'
        '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:
    Fulfillment:
      type: object
      properties:
        object:
          type: string
          enum:
            - fulfillment
        id:
          type: string
          format: uuid
        orderId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - open
            - success
            - cancelled
            - error
            - failure
          description: BedrockFulfillmentStatus
        source:
          type:
            - string
            - 'null'
          enum:
            - reploLabel
            - manual
            - shipstation
            - csv
            - api
            - printful
            - null
          description: >-
            The tool that recorded the package; null for packages recorded
            before sources were tracked.
        trackingCarrier:
          type:
            - string
            - 'null'
        trackingNumber:
          type:
            - string
            - 'null'
        trackingUrl:
          type:
            - string
            - 'null'
        shipmentStatus:
          type:
            - string
            - 'null'
          enum:
            - labelPurchased
            - confirmed
            - inTransit
            - outForDelivery
            - attemptedDelivery
            - availableForPickup
            - delivered
            - returnToSender
            - failure
            - null
          description: >-
            Where the package is from the carrier's scans; null when no carrier
            scan is tracked.
        estimatedDeliveryAt:
          type:
            - string
            - 'null'
        shippedAt:
          type:
            - string
            - 'null'
        deliveredAt:
          type:
            - string
            - 'null'
        items:
          type: array
          items:
            type: object
            properties:
              orderItemId:
                type: string
                format: uuid
              quantity:
                type: integer
            required:
              - orderItemId
              - quantity
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - object
        - id
        - orderId
        - status
        - source
        - trackingCarrier
        - trackingNumber
        - trackingUrl
        - shipmentStatus
        - estimatedDeliveryAt
        - shippedAt
        - deliveredAt
        - items
        - createdAt
        - updatedAt
    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.