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

# Add inventory to consolidate shipping order

Adds one or more return-inventory items to an existing consolidate shipping order. Use this between [Create consolidate shipping order](/api-reference/consolidateshippingorder/create-consolidate-shipping-order) and [Confirm consolidate shipping order](/api-reference/consolidateshippingorder/confirm-consolidate-shipping-order) to assemble the order's contents.


## OpenAPI

````yaml post /api/outbound/consolidateShipping/inventory/add
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/inventory/add:
    post:
      tags:
        - ConsolidateShippingInventory
      summary: Add inventory to consolidate shipping order
      operationId: ReturnUserApi_AddConsolidateShippingInventory
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - consolidateShippingOrderId
                - returnInventoryIdList
              properties:
                consolidateShippingOrderId:
                  type: string
                  description: Consolidate shipping order ID (ULID)
                returnInventoryIdList:
                  type: array
                  items:
                    type: integer
                  maxItems: 500
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAddConsolidateShippingInventoryReply'
        '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:
    UserAddConsolidateShippingInventoryReply:
      type: object
      properties:
        consolidateShippingInventoryId:
          type: string
          description: Consolidate shipping inventory ID (ULID)
        consolidateShippingOrderId:
          type: string
          description: ULID
        returnInventoryId:
          type: integer
          format: int64
        consolidateShippingInventoryStatus:
          type: string
        rma:
          type:
            - string
            - 'null'
    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'
    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

````