Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Interface PurchaseShipmentRequest

    The request schema for the purchaseShipment operation.

    interface PurchaseShipmentRequest {
        additionalInputs?: { [key: string]: object };
        rateId: string;
        requestedDocumentSpecification: RequestedDocumentSpecification;
        requestedValueAddedServices?: RequestedValueAddedService[];
        requestToken: string;
    }
    Index
    additionalInputs? rateId requestedDocumentSpecification requestedValueAddedServices? requestToken
    additionalInputs?: { [key: string]: object }

    The additional inputs required to purchase a shipping offering, in JSON format. The JSON provided here must adhere to the JSON schema that is returned in the response to the getAdditionalInputs operation. Additional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation.

    rateId: string

    An identifier for the rate (shipment offering) provided by a shipping service provider.

    requestedDocumentSpecification: RequestedDocumentSpecification
    requestedValueAddedServices?: RequestedValueAddedService[]

    The value-added services to be added to a shipping service purchase.

    requestToken: string

    A unique token generated to identify a getRates operation.

    Settings
    Member Visibility

    On This Page
    Properties