Interface VendorShippingApiGetShipmentDetailsRequest

Request parameters for getShipmentDetails operation in VendorShippingApi.

Export

VendorShippingApiGetShipmentDetailsRequest

interface VendorShippingApiGetShipmentDetailsRequest {
    buyerReferenceNumber?: string;
    buyerWarehouseCode?: string;
    createdAfter?: string;
    createdBefore?: string;
    currentShipmentStatus?: string;
    estimatedDeliveryAfter?: string;
    estimatedDeliveryBefore?: string;
    limit?: number;
    nextToken?: string;
    packageLabelCreatedAfter?: string;
    packageLabelCreatedBefore?: string;
    requestedPickUpAfter?: string;
    requestedPickUpBefore?: string;
    scheduledPickUpAfter?: string;
    scheduledPickUpBefore?: string;
    sellerWarehouseCode?: string;
    shipmentConfirmedAfter?: string;
    shipmentConfirmedBefore?: string;
    shipmentDeliveryAfter?: string;
    shipmentDeliveryBefore?: string;
    shippedAfter?: string;
    shippedBefore?: string;
    sortOrder?: GetShipmentDetailsSortOrderEnum;
    vendorShipmentIdentifier?: string;
}

Properties

buyerReferenceNumber? buyerWarehouseCode? createdAfter? createdBefore? currentShipmentStatus? estimatedDeliveryAfter? estimatedDeliveryBefore? limit? nextToken? packageLabelCreatedAfter? packageLabelCreatedBefore? requestedPickUpAfter? requestedPickUpBefore? scheduledPickUpAfter? scheduledPickUpBefore? sellerWarehouseCode? shipmentConfirmedAfter? shipmentConfirmedBefore? shipmentDeliveryAfter? shipmentDeliveryBefore? shippedAfter? shippedBefore? sortOrder? vendorShipmentIdentifier?

Properties

Optional ReadonlybuyerReferenceNumber

buyerReferenceNumber?: string

Get Shipment Details by passing buyer Reference ID

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlybuyerWarehouseCode

buyerWarehouseCode?: string

Get Shipping Details based on buyer warehouse code. This value should be same as 'shipToParty.partyId' in the Shipment.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlycreatedAfter

createdAfter?: string

Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlycreatedBefore

createdBefore?: string

Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlycurrentShipmentStatus

currentShipmentStatus?: string

Get Shipment Details by passing Current shipment status.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyestimatedDeliveryAfter

estimatedDeliveryAfter?: string

Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyestimatedDeliveryBefore

estimatedDeliveryBefore?: string

Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional Readonlylimit

limit?: number

The limit to the number of records returned. Default value is 50 records.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlynextToken

nextToken?: string

Used for pagination when there are more shipments than the specified result size limit.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlypackageLabelCreatedAfter

packageLabelCreatedAfter?: string

Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlypackageLabelCreatedBefore

packageLabelCreatedBefore?: string

Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyrequestedPickUpAfter

requestedPickUpAfter?: string

Get Shipment Details by passing After Requested pickup date. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyrequestedPickUpBefore

requestedPickUpBefore?: string

Get Shipment Details by passing Before Requested pickup date. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyscheduledPickUpAfter

scheduledPickUpAfter?: string

Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyscheduledPickUpBefore

scheduledPickUpBefore?: string

Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlysellerWarehouseCode

sellerWarehouseCode?: string

Get Shipping Details based on vendor warehouse code. This value should be same as &#39;sellingParty.partyId&#39; in the Shipment.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyshipmentConfirmedAfter

shipmentConfirmedAfter?: string

Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyshipmentConfirmedBefore

shipmentConfirmedBefore?: string

Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyshipmentDeliveryAfter

shipmentDeliveryAfter?: string

Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyshipmentDeliveryBefore

shipmentDeliveryBefore?: string

Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyshippedAfter

shippedAfter?: string

Get Shipment Details by passing Shipped Date After. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyshippedBefore

shippedBefore?: string

Get Shipment Details by passing Shipped Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlysortOrder

sortOrder?: GetShipmentDetailsSortOrderEnum

Sort in ascending or descending order by purchase order creation date.

Memberof

VendorShippingApiGetShipmentDetails

Optional ReadonlyvendorShipmentIdentifier

vendorShipmentIdentifier?: string

Get Shipment Details by passing Vendor Shipment ID

Memberof

VendorShippingApiGetShipmentDetails

Settings

Member Visibility

On This Page

Properties