Supply Sources API v2020-07-01 Reference
Manage the configurations and capabilities of seller supply sources.
Overview
The Selling Partner API for Supply Sources lets you build and manage the configurations and capabilities of seller supply sources. With this API, sellers can also update information about existing supply sources and provide location level inventory.
Version information
Version : 2020-07-01
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
getSupplySources
createSupplySource
getSupplySource
updateSupplySource
archiveSupplySource
updateSupplySourceStatus
Paths
GET /supplySources/2020-07-01/supplySources
Operation: getSupplySources
Description
The path to retrieve paginated supply sources.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Query | nextPageToken optional | The pagination token to retrieve a specific page of results. | string | - |
| Query | pageSize optional | The number of supply sources to return per paginated request. | number | 10 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : The unique request reference ID. | GetSupplySourcesResponse |
| 403 | An error that indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
POST /supplySources/2020-07-01/supplySources
Operation: createSupplySource
Description
Create a new supply source.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | payload required | A request to create a supply source. | CreateSupplySourceRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : The unique request reference ID. | CreateSupplySourceResponse |
| 403 | An error that indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
GET /supplySources/2020-07-01/supplySources/{supplySourceId}
Operation: getSupplySource
Description
Retrieve a supply source.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | supplySourceId required | The unique identifier of a supply source. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : The unique request reference ID. | SupplySource |
| 403 | An error that indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
PUT /supplySources/2020-07-01/supplySources/{supplySourceId}
Operation: updateSupplySource
Description
Update the configuration and capabilities of a supply source.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | supplySourceId required | The unique identitier of a supply source. | string |
| Body | payload optional | A request to update the configuration and capabilities of a supply source. | UpdateSupplySourceRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 403 | An error that indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
DELETE /supplySources/2020-07-01/supplySources/{supplySourceId}
Operation: archiveSupplySource
Description
Archive a supply source, making it inactive. Cannot be undone.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | supplySourceId required | The unique identifier of a supply source. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
PUT /supplySources/2020-07-01/supplySources/{supplySourceId}/status
Operation: updateSupplySourceStatus
Description
Update the status of a supply source.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | supplySourceId required | The unique identifier of a supply source. | string |
| Body | payload optional | A request to update the status of a supply source. | UpdateSupplySourceStatusRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : The unique request reference ID. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | The request has missing or invalid parameters and cannot be parsed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):The unique request reference ID. | ErrorList |
| 404 | The resource specified does not exist. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):The unique request reference ID. | ErrorList |
| 413 | The request size exceeded the maximum accepted size. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):The unique request reference ID. | ErrorList |
| 415 | The request payload is in an unsupported format. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):The unique request reference ID. | ErrorList |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):The unique request reference ID. | ErrorList |
| 503 | The temporary overloading or maintenance of the server. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):The unique request reference ID. | ErrorList |
Definitions
Error
An error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occured. | string |
| message required | A message that describes the error condition in a human-readable form. | string |
| details optional | The additional details that can help the caller understand or fix the issue. | string |
ErrorList
A list of error responses returned when a request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| errors required | A list of error responses returned when a request is unsuccessful. | < Error > array |
GetSupplySourcesResponse
The paginated list of supply sources.
| Name | Description | Schema |
|---|---|---|
| supplySources optional | The list of SupplySources. | SupplySourceList |
| nextPageToken optional | If present, use this pagination token to retrieve the next page of supply sources. | string |
UpdateSupplySourceStatusRequest
A request to update the status of a supply source.
| Name | Description | Schema |
|---|---|---|
| status optional | The SupplySource status | SupplySourceStatus |
CreateSupplySourceRequest
A request to create a supply source.
| Name | Description | Schema |
|---|---|---|
| supplySourceCode required | The seller-provided unique supply source code. | SupplySourceCode |
| alias required | The custom alias for this supply source | SupplySourceAlias |
| address required | A physical address. | Address |
CreateSupplySourceResponse
The result of creating a new supply source.
| Name | Description | Schema |
|---|---|---|
| supplySourceId required | An Amazon generated unique supply source ID. | SupplySourceId |
| supplySourceCode required | The seller-provided unique supply source code. | SupplySourceCode |
UpdateSupplySourceRequest
A request to update the configuration and capabilities of a supply source.
| Name | Description | Schema |
|---|---|---|
| alias optional | The custom alias for this supply source | SupplySourceAlias |
| configuration optional | Includes configuration and timezone of a supply source. | SupplySourceConfiguration |
| capabilities optional | The capabilities of a supply source. | SupplySourceCapabilities |
SupplySource
The supply source details, including configurations and capabilities.
| Name | Description | Schema |
|---|---|---|
| supplySourceId optional | An Amazon generated unique supply source ID. | SupplySourceId |
| supplySourceCode optional | The seller-provided unique supply source code. | SupplySourceCode |
| alias optional | The custom alias for this supply source | SupplySourceAlias |
| status optional | The SupplySource status. | SupplySourceStatusReadOnly |
| address optional | A physical address. | Address |
| configuration optional | Includes configuration and timezone of a supply source. | SupplySourceConfiguration |
| capabilities optional | The capabilities of a supply source. | SupplySourceCapabilities |
| createdAt optional | A date and time in the rfc3339 format. | DateTime |
| updatedAt optional | A date and time in the rfc3339 format. | DateTime |
SupplySourceConfiguration
Includes configuration and timezone of a supply source.
| Name | Description | Schema |
|---|---|---|
| operationalConfiguration optional | The operational configuration of supplySources. | OperationalConfiguration |
| timezone optional | Please see RFC 6557, should be a canonical time zone ID as listed here: https://www.joda.org/joda-time/timezones.html. | string |
SupplySourceCapabilities
The capabilities of a supply source.
| Name | Description | Schema |
|---|---|---|
| outbound optional | The outbound capability of a supply source. | OutboundCapability |
| services optional | The services capability of a supply source. | ServicesCapability |
SupplySourceList
The list of SupplySources.
Type : < SupplySourceList > array
| Name | Schema |
|---|---|
| alias optional | SupplySourceAlias |
| supplySourceId optional | SupplySourceId |
| supplySourceCode optional | SupplySourceCode |
| address optional | Address |
SupplySourceId
An Amazon generated unique supply source ID.
Type : string
SupplySourceCode
The seller-provided unique supply source code.
Type : string
SupplySourceAlias
The custom alias for this supply source
Type : string
SupplySourceStatusReadOnly
The SupplySource status.
Type : enum
| Value | Description |
|---|---|
| Active | - |
| Inactive | - |
| Archived | - |
SupplySourceStatus
The SupplySource status
Type : enum
| Value | Description |
|---|---|
| Active | - |
| Inactive | - |
OutboundCapability
The outbound capability of a supply source.
| Name | Description | Schema |
|---|---|---|
| isSupported optional | - | boolean |
| operationalConfiguration optional | The operational configuration of supplySources. | OperationalConfiguration |
| returnLocation optional | The address or reference to another supplySourceId to act as a return location. | ReturnLocation |
| deliveryChannel optional | The delivery channel of a supply source. | DeliveryChannel |
| pickupChannel optional | The pick up channel of a supply source. | PickupChannel |
ServicesCapability
The services capability of a supply source.
| Name | Description | Schema |
|---|---|---|
| isSupported optional | When true, SupplySource supports the Service capability. | boolean |
| operationalConfiguration optional | The operational configuration of supplySources. | OperationalConfiguration |
PickupChannel
The pick up channel of a supply source.
| Name | Description | Schema |
|---|---|---|
| inventoryHoldPeriod optional | The duration of time. | Duration |
| isSupported optional | - | boolean |
| operationalConfiguration optional | The operational configuration of supplySources. | OperationalConfiguration |
| inStorePickupConfiguration optional | The configuration for supporting in-store pickup. | InStorePickupConfiguration |
| curbsidePickupConfiguration optional | The configuration for supporting curbside pickup. | CurbsidePickupConfiguration |
ParkingConfiguration
The parking configuration.
| Name | Description | Schema |
|---|---|---|
| parkingCostType optional | The type of cost at parking location. | ParkingCostType |
| parkingSpotIdentificationType optional | The type of parking spot identification used at parking location. | ParkingSpotIdentificationType |
| numberOfParkingSpots optional | The number of parking spots. | NonNegativeInteger |
ParkingCostType
The parking cost type.
Type : enum
| Value | Description |
|---|---|
| Free | - |
| Other | - |
ParkingSpotIdentificationType
The type of parking spot identification.
Type : enum
| Value | Description |
|---|---|
| Numbered | - |
| Other | - |
InStorePickupConfiguration
The in-store pickup configuration of a supply source.
| Name | Description | Schema |
|---|---|---|
| isSupported optional | When true, in-store pickup is supported by the supply source (default: isSupported value in PickupChannel). | boolean |
| parkingConfiguration optional | The parking configuration for in-store pickup. | ParkingConfiguration |
CurbsidePickupConfiguration
The curbside pickup configuration of a supply source.
| Name | Description | Schema |
|---|---|---|
| isSupported optional | When true, curbside pickup is supported by the supply source. | boolean |
| operationalConfiguration optional | The operational configuration for the curbside pickup configuration. | OperationalConfiguration |
| parkingWithAddressConfiguration optional | The parking configuration for curbside pickup with address for customers to use. | ParkingWithAddressConfiguration |
ParkingWithAddressConfiguration
The parking configuration with the address.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| parkingCostType optional | The type of cost at parking location. | ParkingCostType |
| parkingSpotIdentificationType optional | The type of parking spot identification used at parking location. | ParkingSpotIdentificationType |
| numberOfParkingSpots optional | The number of parking spots. | NonNegativeInteger |
| address optional | The address of the parking location. | Address |
DeliveryChannel
The delivery channel of a supply source.
| Name | Description | Schema |
|---|---|---|
| isSupported optional | - | boolean |
| operationalConfiguration optional | The operational configuration of supplySources. | OperationalConfiguration |
OperationalConfiguration
The operational configuration of supplySources.
| Name | Description | Schema |
|---|---|---|
| contactDetails optional | The contact details | ContactDetails |
| throughputConfig optional | The throughput configuration. | ThroughputConfig |
| operatingHoursByDay optional | The operating hours per day | OperatingHoursByDay |
| handlingTime optional | The duration of time. | Duration |
Duration
The duration of time.
| Name | Description | Schema |
|---|---|---|
| value optional | An unsigned integer that can be only positive or zero. | NonNegativeInteger |
| timeUnit optional | The time unit | TimeUnit |
ThroughputConfig
The throughput configuration.
| Name | Description | Schema |
|---|---|---|
| throughputCap optional | The throughput capacity | ThroughputCap |
| throughputUnit required | The throughput unit | ThroughputUnit |
ReturnLocation
The address or reference to another supplySourceId to act as a return location.
| Name | Description | Schema |
|---|---|---|
| supplySourceId optional | The Amazon provided supplySourceId where orders can be returned to. | string |
| addressWithContact optional | The address and contact details. | AddressWithContact |
AddressWithContact
The address and contact details.
| Name | Description | Schema |
|---|---|---|
| contactDetails optional | The contact details | ContactDetails |
| address optional | A physical address. | Address |
ContactDetails
The contact details
| Name | Schema |
|---|---|
| primary optional | primary |
| Name | Description | Schema |
|---|---|---|
| email optional | - | EmailAddress |
| phone optional | The phone number of the person, business or institution. | string |
ThroughputCap
The throughput capacity
| Name | Description | Schema |
|---|---|---|
| value optional | An unsigned integer that can be only positive or zero. | NonNegativeInteger |
| timeUnit optional | The time unit | TimeUnit |
OperatingHour
The operating hour schema
| Name | Description | Schema |
|---|---|---|
| startTime optional | The opening time, ISO 8601 formatted timestamp without date, HH:mm. | string |
| endTime optional | The closing time, ISO 8601 formatted timestamp without date, HH:mm. | string |
OperatingHours
A list of Operating Hours.
Type : < OperatingHour > array
ThroughputUnit
The throughput unit
Type : enum
| Value | Description |
|---|---|
| Order | - |
OperatingHoursByDay
The operating hours per day
| Name | Description | Schema |
|---|---|---|
| monday optional | A list of Operating Hours. | OperatingHours |
| tuesday optional | A list of Operating Hours. | OperatingHours |
| wednesday optional | A list of Operating Hours. | OperatingHours |
| thursday optional | A list of Operating Hours. | OperatingHours |
| friday optional | A list of Operating Hours. | OperatingHours |
| saturday optional | A list of Operating Hours. | OperatingHours |
| sunday optional | A list of Operating Hours. | OperatingHours |
TimeUnit
The time unit
Type : enum
| Value | Description |
|---|---|
| Hours | - |
| Minutes | - |
| Days | - |
NonNegativeInteger
An unsigned integer that can be only positive or zero.
Type : integer
Minimum : 0
EmailAddress
The email address to which email messages are delivered.
Type : string
Pattern : ^([a-zA-Z0-9_-.]+)@([a-zA-Z0-9_-.]+).([a-zA-Z]{2,5})$
Address
A physical address.
| Name | Description | Schema |
|---|---|---|
| name required | The name of the person, business or institution at that address. | string |
| addressLine1 required | The first line of the address. | string |
| addressLine2 optional | The additional address information, if required. | string |
| addressLine3 optional | The additional address information, if required. | string |
| city optional | The city where the person, business or institution is located. | string |
| county optional | The county where person, business or institution is located. | string |
| district optional | The district where person, business or institution is located. | string |
| stateOrRegion required | The state or region where person, business or institution is located. | string |
| postalCode optional | The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation. | string |
| countryCode required | The two digit country code. In ISO 3166-1 alpha-2 format. | string |
| phone optional | The phone number of the person, business or institution located at that address. | string |
DateTime
A date and time in the rfc3339 format.
Type : string
Updated 4 months ago