JUjumpseller
Fulfillments

Retrieve a Fulfillments List from a query.

Changed on

Fulfillments are ordered by creation date, newest first. Results are wrapped in an object with the total count.

get/fulfillments/search.json

Request

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

Query parameters

querystring

Tracking number, Order id or manifest id to search for.

status_filtersstring
Example:requested,in_transit

Comma-separated shipment statuses: requested, in_transit, delivered, failed, pickup_available, in_preparation. requested also matches manual fulfillments without a status.

fulfillment_type_filterstring
Example:manual,chilexpress

Comma-separated fulfillment types (see type in the Fulfillment).

tracking_company_filterstring

Comma-separated tracking companies. manual matches every company that is not a fulfillment service.

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

Filter by creation date, in the store timezone. With customDate, use initialDate and finalDate.

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.

latnumber float

Latitude of the center point. Used with lon and radius to keep fulfillments whose Order shipping address is within the radius.

lonnumber float

Longitude of the center point.

radiusinteger

Radius in kilometers.

filter_empty_addressesboolean

When true, only fulfillments whose Order has a shipping address are returned.

limitinteger

Number of objects per page (maximum 100).

pageinteger

Page number, starting at 1.

Response

OK

countinteger

Total number of fulfillments matching the query

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

      endpoint added