Request parameters for getPurchaseOrders operation in VendorOrdersApi.

VendorOrdersApiGetPurchaseOrdersRequest

interface VendorOrdersApiGetPurchaseOrdersRequest {
    changedAfter?: string;
    changedBefore?: string;
    createdAfter?: string;
    createdBefore?: string;
    includeDetails?: boolean;
    isPOChanged?: boolean;
    limit?: number;
    nextToken?: string;
    orderingVendorCode?: string;
    poItemState?: "Cancelled";
    purchaseOrderState?: GetPurchaseOrdersPurchaseOrderStateEnum;
    sortOrder?: GetPurchaseOrdersSortOrderEnum;
}

Properties

changedAfter?: string

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

VendorOrdersApiGetPurchaseOrders

changedBefore?: string

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

VendorOrdersApiGetPurchaseOrders

createdAfter?: string

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

VendorOrdersApiGetPurchaseOrders

createdBefore?: string

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

VendorOrdersApiGetPurchaseOrders

includeDetails?: boolean

When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.

VendorOrdersApiGetPurchaseOrders

isPOChanged?: boolean

When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.

VendorOrdersApiGetPurchaseOrders

limit?: number

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

VendorOrdersApiGetPurchaseOrders

nextToken?: string

Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call

VendorOrdersApiGetPurchaseOrders

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 the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.

VendorOrdersApiGetPurchaseOrders

poItemState?: "Cancelled"

Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.

VendorOrdersApiGetPurchaseOrders

Filters purchase orders based on the purchase order state.

VendorOrdersApiGetPurchaseOrders

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

VendorOrdersApiGetPurchaseOrders