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.

Examples

literal blocks:

SupplySources().get_supply_sources()
Parameters:

  • nextPageToken (key) – object | The pagination token to retrieve a specific page of results.

  • pageSize (key) – object | The number of supply sources to return per paginated request.

Returns:

ApiResponse

create_supply_source(self, **kwargs) → ApiResponse#

Create a new supply source.

Examples

literal blocks:

SupplySources().create_supply_source()
Parameters:

payload – CreateSupplySourceRequest | required A request to create a supply source.

Returns:

ApiResponse

get_supply_source(self, supplySourceId, **kwargs) → ApiResponse#

Retrieve a supply source.

Examples

literal blocks:

SupplySources().get_supply_source("value")
Parameters:

supplySourceId – object | required The unique identifier of a supply source.

Returns:

ApiResponse

update_supply_source(self, supplySourceId, **kwargs) → ApiResponse#

Update the configuration and capabilities of a supply source.

Examples

literal blocks:

SupplySources().update_supply_source("value")
Parameters:

  • supplySourceId – object | required The unique identitier of a supply source.

  • payload – UpdateSupplySourceRequest |

Returns:

ApiResponse

archive_supply_source(self, supplySourceId, **kwargs) → ApiResponse#

Archive a supply source, making it inactive. Cannot be undone.

Examples

literal blocks:

SupplySources().archive_supply_source("value")
Parameters:

supplySourceId – object | required The unique identifier of a supply source.

Returns:

ApiResponse

update_supply_source_status(self, supplySourceId, **kwargs) → ApiResponse#

Update the status of a supply source.

Examples

literal blocks:

SupplySources().update_supply_source_status("value")
Parameters:

  • supplySourceId – object | required The unique identifier of a supply source.

  • payload – UpdateSupplySourceStatusRequest |

Returns:

ApiResponse