Request parameters for getPurchaseOrdersStatus operation in VendorOrdersApi.

VendorOrdersApiGetPurchaseOrdersStatusRequest

interface VendorOrdersApiGetPurchaseOrdersStatusRequest {
    createdAfter?: string;
    createdBefore?: string;
    itemConfirmationStatus?: GetPurchaseOrdersStatusItemConfirmationStatusEnum;
    itemReceiveStatus?: GetPurchaseOrdersStatusItemReceiveStatusEnum;
    limit?: number;
    nextToken?: string;
    orderingVendorCode?: string;
    purchaseOrderNumber?: string;
    purchaseOrderStatus?: GetPurchaseOrdersStatusPurchaseOrderStatusEnum;
    shipToPartyId?: string;
    sortOrder?: GetPurchaseOrdersStatusSortOrderEnum;
    updatedAfter?: string;
    updatedBefore?: string;
}

Properties

createdAfter?: string

Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.

VendorOrdersApiGetPurchaseOrdersStatus

createdBefore?: string

Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.

VendorOrdersApiGetPurchaseOrdersStatus

Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included.

VendorOrdersApiGetPurchaseOrdersStatus

Filters purchase orders based on the purchase order's item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included.

VendorOrdersApiGetPurchaseOrdersStatus

limit?: number

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

VendorOrdersApiGetPurchaseOrdersStatus

nextToken?: string

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

VendorOrdersApiGetPurchaseOrdersStatus

orderingVendorCode?: string

Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned.

VendorOrdersApiGetPurchaseOrdersStatus

purchaseOrderNumber?: string

Provides purchase order status for the specified purchase order number.

VendorOrdersApiGetPurchaseOrdersStatus

Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.

VendorOrdersApiGetPurchaseOrdersStatus

shipToPartyId?: string

Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor group purchase orders.

VendorOrdersApiGetPurchaseOrdersStatus

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

VendorOrdersApiGetPurchaseOrdersStatus

updatedAfter?: string

Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.

VendorOrdersApiGetPurchaseOrdersStatus

updatedBefore?: string

Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.

VendorOrdersApiGetPurchaseOrdersStatus