VendorDirectFulfillmentShipping V1

class sp_api.api.VendorDirectFulfillmentShippingV1(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'>)

VendorDirectFulfillmentShipping SP-API Client :link:

The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor’s shipping data.

get_shipping_labels(self, **kwargs) → ApiResponse

Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().get_shipping_labels()

Parameters:

• shipFromPartyId (key) – object | The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.

• limit (key) – object | The limit to the number of records returned.

• createdAfter (key) – object | required Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.

• createdBefore (key) – object | required Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.

• sortOrder (key) – object | Sort ASC or DESC by order creation date.

• nextToken (key) – object | Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.

Returns:

ApiResponse

submit_shipping_label_request(self, **kwargs) → ApiResponse

Creates a shipping label for a purchase order and returns a transactionId for reference.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().submit_shipping_label_request()

Parameters:

body – SubmitShippingLabelsRequest | required Request body containing one or more shipping labels data.

Returns:

ApiResponse

get_shipping_label(self, purchaseOrderNumber, **kwargs) → ApiResponse

Returns a shipping label for the purchaseOrderNumber that you specify.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().get_shipping_label("value")

Parameters:

purchaseOrderNumber – object | required The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.

Returns:

ApiResponse

submit_shipment_confirmations(self, **kwargs) → ApiResponse

Submits one or more shipment confirmations for vendor orders.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().submit_shipment_confirmations()

Parameters:

body – SubmitShipmentConfirmationsRequest | required Request body containing the shipment confirmations data.

Returns:

ApiResponse

submit_shipment_status_updates(self, **kwargs) → ApiResponse

This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().submit_shipment_status_updates()

Parameters:

body – SubmitShipmentStatusUpdatesRequest | required Request body containing the shipment status update data.

Returns:

ApiResponse

get_customer_invoices(self, **kwargs) → ApiResponse

Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().get_customer_invoices()

Parameters:

• shipFromPartyId (key) – object | The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.

• limit (key) – object | The limit to the number of records returned

• createdAfter (key) – object | required Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.

• createdBefore (key) – object | required Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.

• sortOrder (key) – object | Sort ASC or DESC by order creation date.

• nextToken (key) – object | Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.

Returns:

ApiResponse

get_customer_invoice(self, purchaseOrderNumber, **kwargs) → ApiResponse

Returns a customer invoice based on the purchaseOrderNumber that you specify.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().get_customer_invoice("value")

Parameters:

purchaseOrderNumber – object | required Purchase order number of the shipment for which to return the invoice.

Returns:

ApiResponse

get_packing_slips(self, **kwargs) → ApiResponse

Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().get_packing_slips()

Parameters:

• shipFromPartyId (key) – object | The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.

• limit (key) – object | The limit to the number of records returned

• createdAfter (key) – object | required Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.

• createdBefore (key) – object | required Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.

• sortOrder (key) – object | Sort ASC or DESC by packing slip creation date.

• nextToken (key) – object | Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.

Returns:

ApiResponse

get_packing_slip(self, purchaseOrderNumber, **kwargs) → ApiResponse

Returns a packing slip based on the purchaseOrderNumber that you specify.

Usage Plan:

Rate (requests per second)	Burst
10	10

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

Examples

literal blocks:

VendorDirectFulfillmentShippingV1().get_packing_slip("value")

Parameters:

purchaseOrderNumber – object | required The purchaseOrderNumber for the packing slip you want.

Returns:

ApiResponse