Orders

Retrieve orders filtered by status.

Changed on
get/orders/status/{status}.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://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 2
      Authorization code: https://accounts.jumpseller.com/oauth/authorize
      Token URL: https://accounts.jumpseller.com/oauth/token scopes: read_orders

Path parameters

status'abandoned' | 'canceled' | 'pending_payment' | 'paid' required

Status of the Order used as filter. Titleized values (e.g. Pending Payment) are also accepted.

Query parameters

fieldsstring
Example:id,status,total,products

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.

limitinteger

Number of objects per page (maximum 100).

pageinteger

Page number, starting at 1.

Response

OK

Changes

    • info

      added the optional property // to the response with the status

    • info

      removed the volta enum value from the //// response property for the response 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 property // became nullable for the status

    • breaking

      the //// response's property format changed from string to no format for status

    • breaking

      the /// response's property type changed from number to string for status

    • breaking

      the /// response's property type changed from number to string for status

    • breaking

      the /// response's property type changed from number to string for 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 Created enum value to the // response property for the response status

    • warning

      added the new Created enum value to the // response property for the response status

    • warning

      added the new billing enum value to the //// response property for the response status

    • warning

      added the new contact enum value to the //// response property for the response status

    • warning

      added the new fulfilled enum value to the // response property for the response status

    • warning

      added the new fulfilled enum value to the // response property for the response status

    • warning

      added the new in_preparation enum value to the // response property for the response status

    • warning

      added the new not_applicable enum value to the // response property for the response status

    • warning

      added the new other enum value to the //// response property for the response status

    • warning

      added the new partial enum value to the // response property for the response status

    • warning

      added the new point_pickup enum value to the // response property for the response status

    • warning

      added the new shipping enum value to the //// response property for the response status

    • warning

      added the new unfulfilled enum value to the // response property for the response status

    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page

    • 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 Delivered enum value from the // response property for the response status

    • info

      removed the Failed enum value from the // response property for the response status

    • info

      removed the In Transit enum value from the // response property for the response status

    • info

      removed the Pickup Available enum value from the // response property for the response status

    • info

      removed the Requested enum value from the // response property for the response status

    • info

      removed the Unfulfilled enum value from the // response property for the response status