---
title: "retrieveShippingOptions"
method: GET
path: "/externalFulfillment/2024-09-11/shipments/{shipmentId}/shippingOptions"
tags: ["External Fulfillment Shipping v2024-09-11"]
---

# retrieveShippingOptions

`GET /externalFulfillment/2024-09-11/shipments/{shipmentId}/shippingOptions`

Get a list of shipping options for a package in a shipment given the shipment's marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.

## Path parameters

- `shipmentId` string, required

## Query parameters

- `packageId` string, required

## Response `200`

Success.

- ShippingOptionsResponse — The response to the `retrieveShippingOptions` operation. The response contains shipping options on a per-package basis from which the seller has to select one shipping option while they retrieve the shipping label. If the particular marketplace channel does not support scheduled shipping options, then this response will be empty.
  - `shippingOptions` ShippingOptions[] — A list of shipping options.
    - `shippingOptionId` string, required — An identifier for the shipping option.
    - `shipBy` 'MARKETPLACE' | 'SELLER' | 'THIRD_PARTY_CARRIER' | 'OTHER', required — The shipper type.
    - `carrierName` string — The carrier name for the offering.
    - `pickupWindow` TimeWindow — Specific time interval defining the start and end times.
      - `startTime` HourMinute — The time when the business opens or closes.
        - `hour` integer — The hour when the business opens or closes, in 24-hour format (0-23).
        - `minute` integer — The minute when the business opens or closes.
      - `endTime` HourMinute — The time when the business opens or closes.
        - `hour` integer — The hour when the business opens or closes, in 24-hour format (0-23).
        - `minute` integer — The minute when the business opens or closes.
    - `timeSlot` TimeWindow — Specific time interval defining the start and end times.
      - `startTime` HourMinute — The time when the business opens or closes.
        - `hour` integer — The hour when the business opens or closes, in 24-hour format (0-23).
        - `minute` integer — The minute when the business opens or closes.
      - `endTime` HourMinute — The time when the business opens or closes.
        - `hour` integer — The hour when the business opens or closes, in 24-hour format (0-23).
        - `minute` integer — The minute when the business opens or closes.
    - `handoverLocation` HandoverLocation — The drop-off location details for package handover.
      - `address` Address — Address of the party.
        - `name` string, required — The name of the person, business or institution at that address.
        - `addressLine1` string, required — First line of the address.
        - `addressLine2` string — Additional street address information, if required.
        - `addressLine3` string — Additional street address information, if required.
        - `city` string — The city where the person, business or institution is located.
        - `county` string — The county where person, business or institution is located.
        - `district` string — The district where person, business or institution is located.
        - `stateOrRegion` string — The state or region where person, business or institution is located.
        - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
        - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
        - `phone` string — The phone number of the person, business or institution located at that address.
      - `distance` Distance — A distance measurement.
        - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
        - `distanceUnit` 'MI' | 'KM', required — The unit of measurement of the distance.
      - `mapUrl` string — URL to the map that shows the drop-off location.
  - `recommendedShippingOption` ShippingOptions — Shipping options for a single package.
    - `shippingOptionId` string, required — An identifier for the shipping option.
    - `shipBy` 'MARKETPLACE' | 'SELLER' | 'THIRD_PARTY_CARRIER' | 'OTHER', required — The shipper type.
    - `carrierName` string — The carrier name for the offering.
    - `pickupWindow` TimeWindow — Specific time interval defining the start and end times.
      - `startTime` HourMinute — The time when the business opens or closes.
        - `hour` integer — The hour when the business opens or closes, in 24-hour format (0-23).
        - `minute` integer — The minute when the business opens or closes.
      - `endTime` HourMinute — The time when the business opens or closes.
        - `hour` integer — The hour when the business opens or closes, in 24-hour format (0-23).
        - `minute` integer — The minute when the business opens or closes.
    - `timeSlot` TimeWindow — Specific time interval defining the start and end times.
      - `startTime` HourMinute — The time when the business opens or closes.
        - `hour` integer — The hour when the business opens or closes, in 24-hour format (0-23).
        - `minute` integer — The minute when the business opens or closes.
      - `endTime` HourMinute — The time when the business opens or closes.
        - `hour` integer — The hour when the business opens or closes, in 24-hour format (0-23).
        - `minute` integer — The minute when the business opens or closes.
    - `handoverLocation` HandoverLocation — The drop-off location details for package handover.
      - `address` Address — Address of the party.
        - `name` string, required — The name of the person, business or institution at that address.
        - `addressLine1` string, required — First line of the address.
        - `addressLine2` string — Additional street address information, if required.
        - `addressLine3` string — Additional street address information, if required.
        - `city` string — The city where the person, business or institution is located.
        - `county` string — The county where person, business or institution is located.
        - `district` string — The district where person, business or institution is located.
        - `stateOrRegion` string — The state or region where person, business or institution is located.
        - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
        - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
        - `phone` string — The phone number of the person, business or institution located at that address.
      - `distance` Distance — A distance measurement.
        - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
        - `distanceUnit` 'MI' | 'KM', required — The unit of measurement of the distance.
      - `mapUrl` string — URL to the map that shows the drop-off location.

## Other responses

- `400` — Request has missing or invalid parameters and cannot be parsed.
- `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
- `404` — The resource specified does not exist.
- `409` — The resource specified conflicts with the current state
- `413` — The request size exceeded the maximum accepted size.
- `415` — The request payload is in an unsupported format.
- `422` — Unprocessable Entity. Unable to process the contained instructions
- `429` — The frequency of requests was greater than allowed.
- `500` — An unexpected condition occurred that prevented the server from fulfilling the request.
- `503` — Temporary overloading or maintenance of the server.

---

[API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)