Shipping

class sp_api.api.Shipping(marketplace: sp_api.base.marketplaces.Marketplaces = Marketplaces.US, *, refresh_token=None, account='default', credentials=None, restricted_data_token=None)

Shipping SP-API Client :link:

Provides programmatic access to Amazon Shipping APIs.

create_shipment(**kwargs)

create_shipment(self, **kwargs) -> ApiResponse

Create a new shipment.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

5 | 15 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

body: | * REQUIRED {‘description’: ‘The request schema for the createShipment operation.’,

‘properties’: {‘clientReferenceId’: {‘$ref’: ‘#/definitions/ClientReferenceId’}, ‘containers’: {‘$ref’: ‘#/definitions/ContainerList’}, ‘shipFrom’: {‘$ref’: ‘#/definitions/Address’}, ‘shipTo’: {‘$ref’: ‘#/definitions/Address’}}, ‘required’: [‘clientReferenceId’, ‘containers’, ‘shipFrom’, ‘shipTo’], ‘type’: ‘object’}

Returns:

ApiResponse:

get_shipment(**kwargs)

get_shipment(self, shipmentId, **kwargs) -> ApiResponse

Return the entire shipment object for the shipmentId.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

5 | 15 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

shipmentId:string | * REQUIRED

Returns:

ApiResponse:

cancel_shipment(**kwargs)

cancel_shipment(self, shipmentId, **kwargs) -> ApiResponse

Cancel a shipment by the given shipmentId.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

5 | 15 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

shipmentId:string | * REQUIRED

Returns:

ApiResponse:

purchase_labels(**kwargs)

purchase_labels(self, shipmentId, **kwargs) -> ApiResponse

Purchase shipping labels based on a given rate.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

5 | 15 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

shipmentId:string | * REQUIRED

body: | * REQUIRED {‘description’: ‘The request schema for the purchaseLabels operation.’,

‘properties’: {‘labelSpecification’: {‘$ref’: ‘#/definitions/LabelSpecification’}, ‘rateId’: {‘$ref’: ‘#/definitions/RateId’}}, ‘required’: [‘labelSpecification’, ‘rateId’], ‘type’: ‘object’}

Returns:

ApiResponse:

retrieve_shipping_label(**kwargs)

retrieve_shipping_label(self, shipmentId, **kwargs) -> ApiResponse

Retrieve shipping label based on the shipment id and tracking id.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

5 | 15 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

shipmentId:string | * REQUIRED

trackingId:string | * REQUIRED

body: | * REQUIRED {‘description’: ‘The request schema for the retrieveShippingLabel operation.’, ‘properties’: {‘labelSpecification’: {‘$ref’: ‘#/definitions/LabelSpecification’}}, ‘required’: [‘labelSpecification’], ‘type’: ‘object’}

Returns:

ApiResponse:

purchase_shipment(**kwargs)

purchase_shipment(self, **kwargs) -> ApiResponse

Purchase shipping labels.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

5 | 15 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

body: | * REQUIRED {‘description’: ‘The payload schema for the purchaseShipment operation.’,

‘properties’: {‘clientReferenceId’: {‘$ref’: ‘#/definitions/ClientReferenceId’},

‘containers’: {‘$ref’: ‘#/definitions/ContainerList’}, ‘labelSpecification’: {‘$ref’: ‘#/definitions/LabelSpecification’}, ‘serviceType’: {‘$ref’: ‘#/definitions/ServiceType’}, ‘shipDate’: {‘description’: ‘The start date and time. This defaults to the current date and time.’, ‘format’: ‘date-time’, ‘type’: ‘string’}, ‘shipFrom’: {‘$ref’: ‘#/definitions/Address’}, ‘shipTo’: {‘$ref’: ‘#/definitions/Address’}},

‘required’: [‘clientReferenceId’, ‘containers’, ‘labelSpecification’, ‘serviceType’, ‘shipFrom’, ‘shipTo’], ‘type’: ‘object’}

Returns:

ApiResponse:

get_rates(**kwargs)

get_rates(self, **kwargs) -> ApiResponse

Get service rates.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

5 | 15 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

body: | * REQUIRED {‘description’: ‘The payload schema for the getRates operation.’,

‘properties’: {‘containerSpecifications’: {‘$ref’: ‘#/definitions/ContainerSpecificationList’},

‘serviceTypes’: {‘$ref’: ‘#/definitions/ServiceTypeList’}, ‘shipDate’: {‘description’: ‘The start date and time. This defaults to the current date and time.’, ‘format’: ‘date-time’, ‘type’: ‘string’}, ‘shipFrom’: {‘$ref’: ‘#/definitions/Address’}, ‘shipTo’: {‘$ref’: ‘#/definitions/Address’}},

‘required’: [‘containerSpecifications’, ‘serviceTypes’, ‘shipFrom’, ‘shipTo’], ‘type’: ‘object’}

Returns:

ApiResponse:

get_account(**kwargs)

get_account(self, **kwargs) -> ApiResponse

Verify if the current account is valid.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

5 | 15 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

Returns:

ApiResponse:

get_tracking_information(**kwargs)

get_tracking_information(self, trackingId, **kwargs) -> ApiResponse

Return the tracking information of a shipment.

Usage Plan:

Rate (requests per second) | Burst |

—- | —- |

1 | 1 |

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Args:

trackingId:string | * REQUIRED

Returns:

ApiResponse: