Retrieve orders filtered by status.
Changed onRequest
- Base URLhttps://api.jumpseller.com/v1
- URLhttps://api.jumpseller.com/v1/orders/status/{status}.json
- Auth
- HTTP basic
- or API key in query parameter login and API key in query parameter authtoken
- or OAuth 2Authorization code: https://accounts.jumpseller.com/oauth/authorizeToken URL: https://accounts.jumpseller.com/oauth/token scopes: read_orders
Path parameters
Status of the Order used as filter. Titleized values (e.g. Pending Payment) are also accepted.
Query parameters
Comma-separated list of fields to include in each Order. All fields except cart_id are returned when omitted. gift_cards returns gift_cards_discount, taxes returns shipping_taxes and status returns both status and status_name. Available fields: id, source, cart_id, created_at, completed_at, currency, subtotal, tax, shipping_tax, shipping, shipping_required, total, discount, shipping_discount, gift_cards, fulfillment_status, shipping_method_id, shipping_service_id, shipping_method_name, payment_method_name, payment_method_type, payment_information, payment_notification_id, additional_information, duplicate_url, recovery_url, review_url, checkout_url, coupons, promotions, customer, shipping_branch, shipping_address, billing_address, pickup_address, products, additional_fields, taxes, status, tracking_url, tracking_company, tracking_number, shipping_option, same_day_delivery, shipment_status, shipment_status_enum, recovered_from, external_shipping_rate_id, external_shipping_rate_description, billing_information.
Number of objects per page (maximum 100).
Page number, starting at 1.
Response
OK
Changes
- info
added the optional property
//to the response with the status - info
removed the
voltaenum value from the////response property for the response status
- info
- breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
//became nullable for the status - breaking
the response property
//became nullable for the status - breaking
the
////response's property format changed fromstringto no format for status - breaking
the
///response's property type changed fromnumbertostringfor status - breaking
the
///response's property type changed fromnumbertostringfor status - breaking
the
///response's property type changed fromnumbertostringfor status - warning
removed the optional property
////from the response with the status - warning
removed the optional property
////from the response with the status - warning
removed the optional property
//from the response with the status - warning
added the new
Createdenum value to the//response property for the response status - warning
added the new
Createdenum value to the//response property for the response status - warning
added the new
billingenum value to the////response property for the response status - warning
added the new
contactenum value to the////response property for the response status - warning
added the new
fulfilledenum value to the//response property for the response status - warning
added the new
fulfilledenum value to the//response property for the response status - warning
added the new
in_preparationenum value to the//response property for the response status - warning
added the new
not_applicableenum value to the//response property for the response status - warning
added the new
otherenum value to the////response property for the response status - warning
added the new
partialenum value to the//response property for the response status - warning
added the new
point_pickupenum value to the//response property for the response status - warning
added the new
shippingenum value to the////response property for the response status - warning
added the new
unfulfilledenum value to the//response property for the response status - info
added the new optional
queryrequest parameterfields - info
added the new optional
queryrequest parameterlimit - info
added the new optional
queryrequest parameterpage - info
added the non-success response with the status
- info
removed the non-success response with the status
- info
added the optional property
//to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
////to the response with the status - info
removed the
Deliveredenum value from the//response property for the response status - info
removed the
Failedenum value from the//response property for the response status - info
removed the
In Transitenum value from the//response property for the response status - info
removed the
Pickup Availableenum value from the//response property for the response status - info
removed the
Requestedenum value from the//response property for the response status - info
removed the
Unfulfilledenum value from the//response property for the response status
- breaking