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

# 获取 Consolidate Shipping Order

> [!WARNING]
>
> 此页面由 AI 自动翻译。API 技术规格以英文呈现为标准。如有任何疑问，请参阅[英文版本](/api-reference/consolidateshippingorder/get-consolidate-shipping-order)。

返回一个 Consolidate Shipping Order 及其明细和 Shipment。

| 列表 | 内容 |
| - | - |
| `pendingInventoryList` | 尚未打包的明细。`quantity` 为明细总数。 |
| `inProgressInventoryList` | 部分打包的明细。`quantity` 为尚待打包的件数。 |
| `shipmentList[].boxList[].consolidateShippingInventoryList` | 打包在该箱中的明细。`quantity` 为该箱中的件数。 |

`RH_WAREHOUSE` 订单的 `shipTo` 为目的地仓库地址，`packagingType` 为 `null`。`shippingFee` 为各 Shipment 运费之和。

订单不存在或不属于您的账户时，返回 `meta.status: 404`。

要跟踪变更，请使用 Consolidate Shipping 的 [webhook](/zh-Hans/webhooks#consolidate-shipping-cost-updated)，而不是反复调用此端点。


## OpenAPI

````yaml get /api/outbound/consolidateShipping/order/get
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/get:
    get:
      tags:
        - ConsolidateShippingOrder
      summary: Get consolidate shipping order
      operationId: ReturnUserApi_GetConsolidateShippingOrder
      parameters:
        - name: consolidateShippingOrderId
          in: query
          required: true
          schema:
            type: string
          description: Consolidate shipping order ID (ULID)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGetConsolidateShippingOrderReply'
        '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:
    UserGetConsolidateShippingOrderReply:
      type: object
      properties:
        consolidateShippingOrderId:
          type: string
          description: ULID
        consolidateShippingOrderNumber:
          type: string
        outboundWarehouseId:
          type: integer
          format: int32
        destinationType:
          type: string
          enum:
            - CUSTOM_ADDRESS
            - RH_WAREHOUSE
        destinationWarehouseId:
          type:
            - integer
            - 'null'
          format: int32
          description: '`RH_WAREHOUSE` orders only'
        packagingType:
          type:
            - string
            - 'null'
          enum:
            - BOX
            - PALLET
            - null
          description: >-
            `null` on `RH_WAREHOUSE` orders and on `CUSTOM_ADDRESS` orders
            created without one.
        shippingFee:
          type: number
          format: decimal
          description: Sum of the shipments' shipping fees
        deliveryInstructions:
          type:
            - string
            - 'null'
        consolidateShippingOrderStatus:
          type: string
        shipTo:
          allOf:
            - $ref: '#/components/schemas/UserConsolidateShippingOrderShipToPayload'
          description: On `RH_WAREHOUSE` orders, the destination warehouse's address
        customFieldMap:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
        pendingInventoryList:
          type: array
          items:
            $ref: '#/components/schemas/UserConsolidateShippingInventoryPayload'
          description: Lines not yet packed
        inProgressInventoryList:
          type: array
          items:
            $ref: '#/components/schemas/UserConsolidateShippingInventoryPayload'
          description: Lines partly packed. `quantity` is the pieces still to pack
        shipmentList:
          type: array
          items:
            $ref: '#/components/schemas/UserConsolidateShippingShipmentPayload'
    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
    UserConsolidateShippingInventoryPayload:
      type: object
      properties:
        consolidateShippingInventoryId:
          type: string
          description: ULID
        itemType:
          type: string
          enum:
            - RMA
            - FNSKU
        returnInventoryId:
          type:
            - integer
            - 'null'
          format: int64
          description: '`RMA` lines only; `null` on `FNSKU` lines'
        rma:
          type:
            - string
            - 'null'
          description: '`RMA` lines only'
        fnsku:
          type:
            - string
            - 'null'
          description: '`FNSKU` lines only'
        quantity:
          type: integer
          description: >-
            In `pendingInventoryList`, the line's total. In
            `inProgressInventoryList`, the pieces not yet packed. In a box, the
            pieces in that box. Always `1` for `RMA` lines.
        consolidateShippingInventoryStatus:
          type: string
    UserConsolidateShippingShipmentPayload:
      type: object
      properties:
        consolidateShippingShipmentId:
          type: string
          description: ULID
        consolidateShippingShipmentNumber:
          type: string
        consolidateShippingOrderId:
          type: string
          description: ULID
        consolidateShippingShipmentStatus:
          type: string
        currencyCode:
          type: string
          description: ISO 4217 currency code
        shippingFee:
          type: number
          format: decimal
        chargeableWeight:
          type:
            - number
            - 'null'
          format: decimal
          description: Grams. `RH_WAREHOUSE` shipments only, set when the shipment arrives
        awb:
          type:
            - string
            - 'null'
        serviceProvider:
          type:
            - string
            - 'null'
        shipDate:
          type:
            - string
            - 'null'
          format: date-time
        boxList:
          type: array
          items:
            $ref: '#/components/schemas/UserConsolidateShippingShipmentBoxPayload'
    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.
    UserConsolidateShippingShipmentBoxPayload:
      type: object
      properties:
        consolidateShippingShipmentBoxId:
          type: string
          description: ULID
        consolidateShippingShipmentId:
          type: string
          description: ULID
        consolidateShippingShipmentBoxStatus:
          type: string
        boxNumber:
          type: string
        boxType:
          type:
            - string
            - 'null'
        invoiceFileKey:
          type:
            - string
            - 'null'
        weight:
          type:
            - number
            - 'null'
          format: decimal
          description: '`null` on `RH_WAREHOUSE` boxes'
        dimension1:
          type:
            - number
            - 'null'
          format: decimal
          description: Length (longest side). `null` on `RH_WAREHOUSE` boxes
        dimension2:
          type:
            - number
            - 'null'
          format: decimal
          description: Width (second longest side). `null` on `RH_WAREHOUSE` boxes
        dimension3:
          type:
            - number
            - 'null'
          format: decimal
          description: Height (shortest side). `null` on `RH_WAREHOUSE` boxes
        consolidateShippingInventoryList:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/UserConsolidateShippingInventoryPayload'
          description: Lines packed in this box; `null` when the box is empty
  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.