Interface VendorDirectFulfillmentOrdersApiModelVendorOrdersApiGetOrdersRequest

Request parameters for getOrders operation in VendorOrdersApi.

VendorOrdersApiGetOrdersRequest

interface VendorDirectFulfillmentOrdersApiModelVendorOrdersApiGetOrdersRequest {
    createdAfter: string;
    createdBefore: string;
    includeDetails?: boolean;
    limit?: number;
    nextToken?: string;
    shipFromPartyId?: string;
    sortOrder?: "ASC" | "DESC";
    status?: "CANCELLED" | "SHIPPED" | "ACCEPTED" | "NEW";
}

Properties

createdAfter: string

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

VendorOrdersApiGetOrders

createdBefore: string

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

VendorOrdersApiGetOrders

includeDetails?: boolean

When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.

VendorOrdersApiGetOrders

limit?: number

The limit to the number of purchase orders returned.

VendorOrdersApiGetOrders

nextToken?: string

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

VendorOrdersApiGetOrders

shipFromPartyId?: string

The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.

VendorOrdersApiGetOrders

sortOrder?: "ASC" | "DESC"

Sort the list in ascending or descending order by order creation date.

VendorOrdersApiGetOrders

status?: "CANCELLED" | "SHIPPED" | "ACCEPTED" | "NEW"

Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.

VendorOrdersApiGetOrders

MMNEPVFCICPMFPCPTTAAATR