JUjumpseller
Orders

Retrieve all Orders.

Changed on
get/orders.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://api.jumpseller.com/v1/orders.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

Query parameters

localestring

Language of the translatable fields, one of the store's languages (e.g. es). Defaults to the store's default language.

status_filtersstring
Example:paid,pending_payment

Order statuses to filter by. Send comma-separated values (status_filters=paid,canceled) or repeat the parameter as an array (status_filters[]=paid&status_filters[]=canceled).

fulfillment_filtersstring
Example:unfulfilled,partial

Comma-separated fulfillment filters. Accepted values: unfulfilled, partial, fulfilled, not applicable (orders without shipping), or a shipment status of the latest fulfillment: requested, in_transit, delivered, failed, pickup_available, in_preparation.

dateFilter'today' | 'yesterday' | 'last7days' | 'last30days' | 'last90days' | 'quarterToDate' | 'yearToDate' | 'blackFridayToCyberMonday' | 'customDate'

Filter by completion date, in the store timezone. With customDate, use initialDate and finalDate; customDate without both dates returns the last 30 days.

initialDatestring date

Start date (inclusive) in the format YYYY-MM-DD. Only used with dateFilter=customDate and finalDate.

finalDatestring date

End date (inclusive) in the format YYYY-MM-DD. Only used with dateFilter=customDate and initialDate.

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

An array of Orders

Changes

  • 09f991a20d74Revision 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

  • 53dc9f2c1329Revision changes
    • breaking

      removed the enum value ... from the query request parameter fields

    • breaking

      removed the enum value fulfilled from the query request parameter fulfillment_filters

    • breaking

      removed the enum value id from the query request parameter fields

    • breaking

      removed the enum value tax from the query request parameter fields

    • breaking

      removed the enum value unfulfilled from the query request parameter fulfillment_filters

    • breaking

      for the query request parameter finalDate, the format changed from string to date

    • breaking

      for the query request parameter initialDate, the format changed from string to date

    • 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

      for the query request parameter limit, the min was set to 1.00

    • warning

      for the query request parameter page, the min was set to 1.00

    • warning

      deleted the query request parameter status_filters[]

    • 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 status_filters

    • info

      added the new enum value blackFridayToCyberMonday to the query request parameter dateFilter

    • info

      added the new enum value quarterToDate to the query request parameter dateFilter

    • info

      added the new enum value yearToDate to the query request parameter dateFilter

    • info

      for the query request parameter dateFilter, the format was generalized from string to no format

    • info

      for the query request parameter fields, the format was generalized from string to no format

    • info

      for the query request parameter fulfillment_filters, the format was generalized from string to no format

    • info

      for the query request parameter limit, the format was generalized from integer to no format

    • info

      for the query request parameter locale, the format was generalized from string to no format

    • info

      for the query request parameter page, the format was generalized from integer to no format

    • info

      added 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