getSupplySource

Retrieve a supply source.

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

The unique request reference ID.

Body

The supply source details, including configurations and capabilities.

supplySourceId

string

optional

An Amazon generated unique supply source ID.

supplySourceCode

string

optional

The seller-provided unique supply source code.

alias

string

optional

The custom alias for this supply source

status

enum<string>

optional

The SupplySource status.

Allowed values:

ActiveInactiveArchived

address

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

addressLine1

string

required

First line of the address text.

addressLine2

string

optional

Optional second line of the address text.

addressLine3

string

optional

Optional third line of the address text.

city

string

optional

Optional city where this address is located.

countryCode

string

required

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

county

string

optional

Optional county where this address is located.

Example:

Washington

district

string

optional

Optional district where this address is located.

name

string

required

Name of the person, business, or institution at this address.

phoneNumber

string

optional

Optional E.164-formatted phone number for an available contact at this address.

Example:

+14155552671

postalCode

string

optional

Optional postal code where this address is located.

stateOrRegion

string

required

State or region where this address is located. Note that this is contextual to the specified country code.

configuration

object (SupplySourceConfiguration)

optional

Includes configuration and timezone of a supply source.

operationalConfiguration

object (OperationalConfiguration)

optional

The operational configuration of supplySources.

timezone

string

optional

Please see RFC 6557, should be a canonical time zone ID as listed here: https://www.joda.org/joda-time/timezones.html.

capabilities

object (SupplySourceCapabilities)

optional

The capabilities of a supply source.

outbound

object (OutboundCapability)

optional

The outbound capability of a supply source.

services

object (ServicesCapability)

optional

The services capability of a supply source.

createdAt

string <date-time>

optional

A datetime value in ISO 8601 format.

updatedAt

string <date-time>

optional

A datetime value in ISO 8601 format.

Example

{
    "supplySourceId": "string",
    "supplySourceCode": "string",
    "alias": "string",
    "status": "Active",
    "address": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "configuration": {
        "operationalConfiguration": {
            "contactDetails": {
                "primary": {
                    "email": "string",
                    "phone": "string"
                }
            },
            "throughputConfig": {
                "throughputCap": {
                    "value": 0,
                    "timeUnit": "Hours"
                },
                "throughputUnit": "Order"
            },
            "operatingHoursByDay": {
                "monday": [
                    {
                        "startTime": "string",
                        "endTime": "string"
                    }
                ],
                "tuesday": [
                    {
                        "startTime": "string",
                        "endTime": "string"
                    }
                ],
                "wednesday": [
                    {
                        "startTime": "string",
                        "endTime": "string"
                    }
                ],
                "thursday": [
                    {
                        "startTime": "string",
                        "endTime": "string"
                    }
                ],
                "friday": [
                    {
                        "startTime": "string",
                        "endTime": "string"
                    }
                ],
                "saturday": [
                    {
                        "startTime": "string",
                        "endTime": "string"
                    }
                ],
                "sunday": [
                    {
                        "startTime": "string",
                        "endTime": "string"
                    }
                ]
            },
            "handlingTime": {
                "value": 0,
                "timeUnit": "Hours"
            }
        },
        "timezone": "string"
    },
    "capabilities": {
        "outbound": {
            "isSupported": true,
            "operationalConfiguration": {
                "contactDetails": {
                    "primary": {
                        "email": "string",
                        "phone": "string"
                    }
                },
                "throughputConfig": {
                    "throughputCap": {
                        "value": 0,
                        "timeUnit": "Hours"
                    },
                    "throughputUnit": "Order"
                },
                "operatingHoursByDay": {
                    "monday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "tuesday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "wednesday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "thursday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "friday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "saturday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "sunday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ]
                },
                "handlingTime": {
                    "value": 0,
                    "timeUnit": "Hours"
                }
            },
            "returnLocation": {
                "supplySourceId": "string",
                "addressWithContact": {
                    "contactDetails": {
                        "primary": {
                            "email": "string",
                            "phone": "string"
                        }
                    },
                    "address": {
                        "addressLine1": "address_1",
                        "addressLine2": "address_2",
                        "addressLine3": "address_3",
                        "city": "Seattle",
                        "countryCode": "US",
                        "county": "Washington",
                        "district": "District1",
                        "name": "address_name",
                        "phoneNumber": "+14155552671",
                        "postalCode": "123456",
                        "stateOrRegion": "Washington"
                    }
                }
            },
            "deliveryChannel": {
                "isSupported": true,
                "operationalConfiguration": {
                    "contactDetails": {
                        "primary": {
                            "email": "string",
                            "phone": "string"
                        }
                    },
                    "throughputConfig": {
                        "throughputCap": {
                            "value": 0,
                            "timeUnit": "Hours"
                        },
                        "throughputUnit": "Order"
                    },
                    "operatingHoursByDay": {
                        "monday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "tuesday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "wednesday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "thursday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "friday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "saturday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "sunday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ]
                    },
                    "handlingTime": {
                        "value": 0,
                        "timeUnit": "Hours"
                    }
                }
            },
            "pickupChannel": {
                "inventoryHoldPeriod": {
                    "value": 0,
                    "timeUnit": "Hours"
                },
                "isSupported": true,
                "operationalConfiguration": {
                    "contactDetails": {
                        "primary": {
                            "email": "string",
                            "phone": "string"
                        }
                    },
                    "throughputConfig": {
                        "throughputCap": {
                            "value": 0,
                            "timeUnit": "Hours"
                        },
                        "throughputUnit": "Order"
                    },
                    "operatingHoursByDay": {
                        "monday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "tuesday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "wednesday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "thursday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "friday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "saturday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ],
                        "sunday": [
                            {
                                "startTime": "string",
                                "endTime": "string"
                            }
                        ]
                    },
                    "handlingTime": {
                        "value": 0,
                        "timeUnit": "Hours"
                    }
                },
                "inStorePickupConfiguration": {
                    "isSupported": true,
                    "parkingConfiguration": {
                        "parkingCostType": "Free",
                        "parkingSpotIdentificationType": "Numbered",
                        "numberOfParkingSpots": 0
                    }
                },
                "curbsidePickupConfiguration": {
                    "isSupported": true,
                    "operationalConfiguration": {
                        "contactDetails": {
                            "primary": {
                                "email": "string",
                                "phone": "string"
                            }
                        },
                        "throughputConfig": {
                            "throughputCap": {
                                "value": 0,
                                "timeUnit": "Hours"
                            },
                            "throughputUnit": "Order"
                        },
                        "operatingHoursByDay": {
                            "monday": [
                                {
                                    "startTime": "string",
                                    "endTime": "string"
                                }
                            ],
                            "tuesday": [
                                {
                                    "startTime": "string",
                                    "endTime": "string"
                                }
                            ],
                            "wednesday": [
                                {
                                    "startTime": "string",
                                    "endTime": "string"
                                }
                            ],
                            "thursday": [
                                {
                                    "startTime": "string",
                                    "endTime": "string"
                                }
                            ],
                            "friday": [
                                {
                                    "startTime": "string",
                                    "endTime": "string"
                                }
                            ],
                            "saturday": [
                                {
                                    "startTime": "string",
                                    "endTime": "string"
                                }
                            ],
                            "sunday": [
                                {
                                    "startTime": "string",
                                    "endTime": "string"
                                }
                            ]
                        },
                        "handlingTime": {
                            "value": 0,
                            "timeUnit": "Hours"
                        }
                    },
                    "parkingWithAddressConfiguration": {
                        "parkingCostType": "Free",
                        "parkingSpotIdentificationType": "Numbered",
                        "numberOfParkingSpots": 0,
                        "address": {
                            "addressLine1": "address_1",
                            "addressLine2": "address_2",
                            "addressLine3": "address_3",
                            "city": "Seattle",
                            "countryCode": "US",
                            "county": "Washington",
                            "district": "District1",
                            "name": "address_name",
                            "phoneNumber": "+14155552671",
                            "postalCode": "123456",
                            "stateOrRegion": "Washington"
                        }
                    }
                }
            }
        },
        "services": {
            "isSupported": true,
            "operationalConfiguration": {
                "contactDetails": {
                    "primary": {
                        "email": "string",
                        "phone": "string"
                    }
                },
                "throughputConfig": {
                    "throughputCap": {
                        "value": 0,
                        "timeUnit": "Hours"
                    },
                    "throughputUnit": "Order"
                },
                "operatingHoursByDay": {
                    "monday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "tuesday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "wednesday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "thursday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "friday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "saturday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "sunday": [
                        {
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ]
                },
                "handlingTime": {
                    "value": 0,
                    "timeUnit": "Hours"
                }
            }
        }
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses