Supply Sources
- class sp_api.api.SupplySources(marketplace: ~sp_api.base.marketplaces.Marketplaces = Marketplaces.US, *, refresh_token=None, account='default', credentials=None, restricted_data_token=None, proxies=None, verify=True, timeout=None, version=None, credential_providers=None, auth_token_client_class=<class 'sp_api.auth.access_token_client.AccessTokenClient'>)
SupplySources SP-API Client :link:
Manage configurations and capabilities of seller supply sources.
- get_supply_sources(self, **kwargs) ApiResponse
The path to retrieve paginated supply sources.
- Parameters:
nextPageToken (key) – string | The pagination token to retrieve a specific page of results.
pageSize (key) – number | The number of supply sources to return per paginated request.
- Return type:
- create_supply_source(**kwargs) ApiResponse
create_supply_source(self, **kwargs) -> ApiResponse
Create a new supply source.
Args:
payload: | * REQUIRED {‘description’: ‘A request to create a supply source.’,
‘properties’: {‘address’: {‘$ref’: ‘#/definitions/Address’}, ‘alias’: {‘$ref’: ‘#/definitions/SupplySourceAlias’}, ‘supplySourceCode’: {‘$ref’: ‘#/definitions/SupplySourceCode’}}, ‘required’: [‘address’, ‘supplySourceCode’, ‘alias’], ‘type’: ‘object’}
- Returns:
ApiResponse:
- get_supply_source(self, supplySourceId, **kwargs) ApiResponse
Retrieve a supply source.
- Parameters:
supplySourceId – string | * REQUIRED The unique identifier of a supply source.
- Return type:
- update_supply_source(self, supplySourceId, **kwargs) ApiResponse
Update the configuration and capabilities of a supply source.
- Parameters:
supplySourceId – string | * REQUIRED The unique identitier of a supply source.
payload –
{‘description’: ‘A request to update the configuration and capabilities of a supply source.’,’properties’: {‘alias’: {‘$ref’: ‘#/definitions/SupplySourceAlias’}, ‘capabilities’: {‘$ref’: ‘#/definitions/SupplySourceCapabilities’}, ‘configuration’: {‘$ref’: ‘#/definitions/SupplySourceConfiguration’}}, ‘type’: ‘object’}
- Return type:
- archive_supply_source(self, supplySourceId, **kwargs) ApiResponse
Archive a supply source, making it inactive. Cannot be undone.
- Parameters:
supplySourceId – string | * REQUIRED The unique identifier of a supply source.
- Return type:
- update_supply_source_status(self, supplySourceId, **kwargs) ApiResponse
Update the status of a supply source.
- Parameters:
supplySourceId – string | * REQUIRED The unique identifier of a supply source.
payload –
{‘description’: ‘A request to update the status of a supply source.’, ‘properties’: {‘status’: {‘$ref’: ‘#/definitions/SupplySourceStatus’}}, ‘type’: ‘object’}
- Return type: