Module shipping_v2

Module shipping_v2 

Source

Enums§

CancelShipmentError
struct for typed errors of method cancel_shipment
CreateClaimError
struct for typed errors of method create_claim
DirectPurchaseShipmentError
struct for typed errors of method direct_purchase_shipment
GenerateCollectionFormError
struct for typed errors of method generate_collection_form
GetAccessPointsError
struct for typed errors of method get_access_points
GetAdditionalInputsError
struct for typed errors of method get_additional_inputs
GetCarrierAccountFormInputsError
struct for typed errors of method get_carrier_account_form_inputs
GetCarrierAccountsError
struct for typed errors of method get_carrier_accounts
GetCollectionFormError
struct for typed errors of method get_collection_form
GetCollectionFormHistoryError
struct for typed errors of method get_collection_form_history
GetRatesError
struct for typed errors of method get_rates
GetShipmentDocumentsError
struct for typed errors of method get_shipment_documents
GetTrackingError
struct for typed errors of method get_tracking
GetUnmanifestedShipmentsError
struct for typed errors of method get_unmanifested_shipments
LinkCarrierAccount0Error
struct for typed errors of method link_carrier_account_0
LinkCarrierAccountError
struct for typed errors of method link_carrier_account
OneClickShipmentError
struct for typed errors of method one_click_shipment
PurchaseShipmentError
struct for typed errors of method purchase_shipment
SubmitNdrFeedbackError
struct for typed errors of method submit_ndr_feedback
UnlinkCarrierAccountError
struct for typed errors of method unlink_carrier_account

Functions§

cancel_shipment
Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
create_claim
This API will be used to create claim for single eligible shipment. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
direct_purchase_shipment
Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
generate_collection_form
This API Call to generate the collection form. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_access_points
Returns a list of access points in proximity of input postal code. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_additional_inputs
Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_carrier_account_form_inputs
This API will return a list of input schema required to register a shipper account with the carrier. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_carrier_accounts
This API will return Get all carrier accounts for a merchant. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_collection_form
This API reprint a collection form. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_collection_form_history
This API Call to get the history of the previously generated collection forms. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_rates
Returns the available shipping service offerings. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_shipment_documents
Returns the shipping documents associated with a package in a shipment. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_tracking
Returns tracking information for a purchased shipment. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
get_unmanifested_shipments
This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
link_carrier_account
This API associates/links the specified carrier account with the merchant. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
link_carrier_account_0
This API associates/links the specified carrier account with the merchant. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 5 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
one_click_shipment
Purchases a shipping service identifier and returns purchase-related details and documents. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
purchase_shipment
Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
submit_ndr_feedback
This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
unlink_carrier_account
This API Unlink the specified carrier account with the merchant. Usage Plan: | Rate (requests per second) | Burst | | –– | –– | | 80 | 100 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.