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

# Mark consolidate shipping order ready to ship

Tells the warehouse that a `CUSTOM_ADDRESS` order can be shipped. The order moves from `CONFIRMED_QUOTE` to `READY_TO_SHIP`.

| `meta.error` message | Cause |
| - | - |
| `Marking the order ready to ship applies to a custom address destination only, …` | The order is an `RH_WAREHOUSE` order |
| `Consolidate shipping order can not mark ready to ship, status must be CONFIRMED_QUOTE` | Wrong status |


## OpenAPI

````yaml post /api/outbound/consolidateShipping/order/markReadyToShip
openapi: 3.1.0
info:
  title: Return Helper API
  description: API documentation for Return Helper — covering User and Public endpoints.
  version: 1.0.0
servers:
  - url: https://api.returnshelper.com/uat/user
    description: Sandbox — User API
  - url: https://api.returnshelper.com/uat/public
    description: Sandbox — Public API
  - url: https://api.returnhelpercentre.com/v1/user
    description: Production — User API
  - url: https://api.returnhelpercentre.com/v1/public
    description: Production — Public API
  - url: https://api.returnhelperchina.com/user
    description: Production — User API (China)
security:
  - ApiKey: []
    ApiToken: []
paths:
  /api/outbound/consolidateShipping/order/markReadyToShip:
    post:
      tags:
        - ConsolidateShippingOrder
      summary: Mark consolidate shipping order ready to ship
      operationId: ReturnUserApi_MarkReadyToShipConsolidateShippingOrder
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - consolidateShippingOrderId
              properties:
                consolidateShippingOrderId:
                  type: string
                  description: Consolidate shipping order ID (ULID)
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/UserMarkReadyToShipConsolidateShippingOrderReply
        '401':
          description: >-
            Authentication failed. Returned when the `x-rr-apikey` or
            `x-rr-apitoken` header is missing or invalid. The body uses the
            standard `ApiResponse` envelope with `meta.error.message` describing
            the auth failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      security:
        - ApiKey: []
          ApiToken: []
      servers:
        - url: https://api.returnshelper.com/uat/user
          description: Sandbox — User API
components:
  schemas:
    UserMarkReadyToShipConsolidateShippingOrderReply:
      type: object
      properties:
        consolidateShippingOrderId:
          type: string
          description: ULID
        consolidateShippingOrderNumber:
          type: string
        outboundWarehouseId:
          type: integer
          format: int32
        deliveryInstructions:
          type:
            - string
            - 'null'
        consolidateShippingOrderStatus:
          type: string
          description: '`READY_TO_SHIP`'
        currencyCode:
          type: string
          description: ISO 4217 currency code
        shippingFee:
          type: number
          format: decimal
        shipTo:
          $ref: '#/components/schemas/UserConsolidateShippingOrderShipToPayload'
        customFieldMap:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
    ApiResponse:
      type: object
      description: >-
        Universal response envelope. Successful responses include the business
        payload as additional top-level fields alongside `correlationId` and
        `meta`. Failed responses (auth errors, validation errors) only populate
        `correlationId` and `meta`, with `meta.errorCode` and `meta.error`
        describing the failure.
      properties:
        correlationId:
          type:
            - string
            - 'null'
          description: >-
            Unique correlation ID for tracing the request through Return Helper
            systems.
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
    UserConsolidateShippingOrderShipToPayload:
      type: object
      properties:
        shipToCountry:
          type: string
          description: ISO 3166-1 alpha-3 country code
        shipToContactName:
          type: string
        shipToPhone:
          type: string
        shipToFax:
          type:
            - string
            - 'null'
        shipToEmail:
          type: string
          format: email
        shipToCompanyName:
          type: string
        shipToStreet1:
          type: string
        shipToStreet2:
          type:
            - string
            - 'null'
        shipToStreet3:
          type:
            - string
            - 'null'
        shipToCity:
          type: string
        shipToState:
          type: string
        shipToPostalCode:
          type: string
        shipToType:
          type: string
          description: Recipient type, e.g. residential or commercial
    ApiResponseMeta:
      type: object
      description: >-
        Application-level metadata for every API response. Inspect `status` and
        `errorCode` to detect soft-error responses (validation failures arrive
        as HTTP 200 with `meta.status: 400`).
      properties:
        status:
          type: integer
          description: >-
            Application-level status code. For successful operations this
            mirrors the HTTP status (e.g. 200). For validation failures it
            reports the logical status (e.g. 400) even though the wire HTTP
            status is 200.
        data:
          type: object
          additionalProperties:
            type: string
          description: Reserved free-form metadata key/value pairs. Usually empty.
        errorCode:
          type:
            - string
            - 'null'
          description: >-
            Machine-readable error code (e.g. `VALIDATION_FAILED`). Non-null
            only when the operation failed.
        error:
          type: object
          additionalProperties: true
          description: >-
            Field-level or message-level error detail keyed by request property
            name. Empty object on success.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-rr-apikey
      description: Your API key
    ApiToken:
      type: apiKey
      in: header
      name: x-rr-apitoken
      description: Your API token — keep this private

````

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