AWaws-samples
External Fulfillment Shipping v2024-09-11

retrieveShippingOptions

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.

get/externalFulfillment/2024-09-11/shipments/{shipmentId}/shippingOptions

Request

  • Base URL
    https://sellingpartnerapi-na.amazon.com
  • URL
    https://sellingpartnerapi-na.amazon.com/externalFulfillment/2024-09-11/shipments/{shipmentId}/shippingOptions
  • Auth
    none declared

Path parameters

shipmentIdstring required

The ID of the shipment to which the package belongs.

Query parameters

packageIdstring required

The ID of the package for which you want to retrieve shipping options.

Response

Success.

Example response

{
  "shippingOptions": [
    {
      "shippingOptionId": "TEST_CASE_200_SHIPPING_OPTION_ID",
      "carrierName": "ATSPL",
      "shipBy": "MARKETPLACE",
      "pickupWindow": {
        "startTime": 1612933142,
        "endTime": 1612494142
      },
      "timeSlot": {
        "startTime": 1612933142,
        "endTime": 1612494142,
        "handoverMethod": "DROPOFF"
      },
      "handoverLocation": {
        "address": {
          "postalCode": "98101",
          "addressLine1": "123 Main St",
          "city": "Seattle",
          "stateOrRegion": "WA",
          "countryCode": "US",
          "geocodes": {
            "latitude": "47.6062",
            "longitude": "-122.3321"
          }
        },
        "distance": {
          "value": "3.5",
          "distanceUnit": "MI"
        },
        "mapUrl": "https://maps.example.com/location?lat=47.6062&lng=-122.3321"
      }
    }
  ],
  "recommendedShippingOption": {
    "shippingOptionId": "TEST_CASE_200_SHIPPING_OPTION_ID",
    "carrierName": "ATSPL",
    "shipBy": "MARKETPLACE",
    "pickupWindow": {
      "startTime": 1612933142,
      "endTime": 1612494142
    },
    "timeSlot": {
      "startTime": 1612933142,
      "endTime": 1612494142,
      "handoverMethod": "DROPOFF"
    },
    "handoverLocation": {
      "address": {
        "postalCode": "98101",
        "addressLine1": "123 Main St",
        "city": "Seattle",
        "stateOrRegion": "WA",
        "countryCode": "US",
        "geocodes": {
          "latitude": "47.6062",
          "longitude": "-122.3321"
        }
      },
      "distance": {
        "value": "3.5",
        "distanceUnit": "MI"
      },
      "mapUrl": "https://maps.example.com/location?lat=47.6062&lng=-122.3321"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.