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

# Update shipping information for FBA replenishment

Updates the destination shipment information (FBA name, address, reference ID, label file) for a pending replenish instruction. Use this when the original details need to change before the warehouse dispatches the parcel.


## OpenAPI

````yaml post /api/Fba/FbaInstructionReplenish/updateShippingInfo
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/Fba/FbaInstructionReplenish/updateShippingInfo:
    post:
      tags:
        - FbaInstructionReplenish
      summary: Update shipping information for FBA replenishment
      operationId: ReturnUserApi_UpdateShippingInfo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateShippingInfoRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralUserUpdateShippingInfoReply'
        '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:
    UserUpdateShippingInfoRequest:
      type: object
      properties:
        fbaInstructionId:
          type: string
          format: uuid
          description: FBA instruction identifier
        provideLabel:
          type: boolean
          description: Whether to provide a label for the new shipment
        newShipmentReferenceId:
          type: string
          description: New shipment reference / FBA shipment ID
        newShipmentFbaName:
          type: string
          description: Recipient name for the new FBA shipment
        newShipmentStreet1:
          type: string
          description: Address line 1
        newShipmentStreet2:
          type: string
          description: Address line 2
        newShipmentStreet3:
          type: string
          description: Address line 3 (optional)
        newShipmentState:
          type: string
          description: State / province
        newShipmentCity:
          type: string
          description: City
        newShipmentPostalCode:
          type: string
          description: Postal code
        newShipmentCountryCode:
          type: string
          description: ISO3 country code (e.g. GBR, USA)
        filename:
          type: string
          description: Label file name (if providing own label)
        fileKey:
          type: string
          description: Label file key (if providing own label)
      required:
        - fbaInstructionId
        - newShipmentReferenceId
        - newShipmentFbaName
        - newShipmentStreet1
        - newShipmentStreet2
        - newShipmentCity
        - newShipmentPostalCode
        - newShipmentState
    GeneralUserUpdateShippingInfoReply:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserUpdateShippingInfoReply'
          description: Updated shipping information
    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'
    UserUpdateShippingInfoReply:
      type: object
      properties:
        fbaInstructionReplenishId:
          type: string
          format: uuid
        fbaInstructionId:
          type: string
          format: uuid
        handlingStatusCode:
          type:
            - string
            - 'null'
        replenishStatusCode:
          type:
            - string
            - 'null'
        provideLabel:
          type: boolean
        newShipmentFbaName:
          type:
            - string
            - 'null'
        newShipmentStreet1:
          type:
            - string
            - 'null'
        newShipmentStreet2:
          type:
            - string
            - 'null'
        newShipmentStreet3:
          type:
            - string
            - 'null'
        newShipmentState:
          type:
            - string
            - 'null'
        newShipmentCity:
          type:
            - string
            - 'null'
        newShipmentPostalCode:
          type:
            - string
            - 'null'
        newShipmentCountryCode:
          type:
            - string
            - 'null'
        newShipmentReferenceId:
          type:
            - string
            - 'null'
        filename:
          type:
            - string
            - 'null'
        fileKey:
          type:
            - string
            - 'null'
    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

````