> ## 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 运费报价

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

接受仓库为 `CUSTOM_ADDRESS` 订单报的运费。订单从 `CONFIRMED` 变为 `CONFIRMED_QUOTE`。

收到 [Consolidate shipping cost updated](/zh-Hans/webhooks#consolidate-shipping-cost-updated) webhook 后调用，然后[将订单标记为可出货](/zh-Hans/api-reference/consolidateshippingorder/mark-consolidate-shipping-order-ready-to-ship)。

| `meta.error` 信息 | 原因 |
| - | - |
| `Confirming the shipping quote applies to a custom address destination only, …` | 订单是 `RH_WAREHOUSE` 订单 |
| `Consolidate shipping order can not confirm shipping cost, status must be CONFIRMED` | 状态不对 |
| `Shipping fee must be greater than 0` | 仓库尚未报价 |
| `Consolidate shipping order can not confirm shipping cost, there are inventory but no boxing. …` | 仍有明细未打包 |


## OpenAPI

````yaml post /api/outbound/consolidateShipping/order/confirmShippingQuote
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/confirmShippingQuote:
    post:
      tags:
        - ConsolidateShippingOrder
      summary: Confirm consolidate shipping quote
      operationId: ReturnUserApi_ConfirmConsolidateShippingQuote
      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/UserConfirmConsolidateShippingQuoteReply'
        '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:
    UserConfirmConsolidateShippingQuoteReply:
      type: object
      properties:
        consolidateShippingOrderId:
          type: string
          description: ULID
        consolidateShippingOrderNumber:
          type: string
        outboundWarehouseId:
          type: integer
          format: int32
        shippingFee:
          type: number
          format: decimal
        deliveryInstructions:
          type:
            - string
            - 'null'
        consolidateShippingOrderStatus:
          type: string
          description: '`CONFIRMED_QUOTE`'
        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.