--- title: "Retrieve a Fulfillments List from a query." method: GET path: "/fulfillments/search.json" tags: ["Fulfillments"] --- # Retrieve a Fulfillments List from a query. `GET /fulfillments/search.json` ## Request - Base URL: `https://api.jumpseller.com/v1` - URL: `https://api.jumpseller.com/v1/fulfillments/search.json` - Auth: one of: - HTTP basic - API key in query parameter `login` and API key in query parameter `authtoken` - OAuth 2 - Authorization code: `https://accounts.jumpseller.com/oauth/authorize` - Token URL: `https://accounts.jumpseller.com/oauth/token` scopes: `read_fulfillments` Fulfillments are ordered by creation date, newest first. Results are wrapped in an object with the total `count`. ## Query parameters - `query` string - `status_filters` string - `fulfillment_type_filter` string - `tracking_company_filter` string - `dateFilter` 'today' | 'yesterday' | 'last7days' | 'last30days' | 'last90days' | 'quarterToDate' | 'yearToDate' | 'blackFridayToCyberMonday' | 'customDate' - `initialDate` string, date - `finalDate` string, date - `lat` number, float - `lon` number, float - `radius` integer - `filter_empty_addresses` boolean - `limit` integer - `page` integer ## Response `200` OK - object - `count` integer: Total number of fulfillments matching the query - `order_fulfillments` FulfillmentFields[]: Fulfillments of the requested page. Items are not wrapped in an `order_fulfillment` key. - `id` integer: Unique identifier of the Fulfillment - `created_at` string: Fulfillment creation date - `updated_at` string: Fulfillment last update date - `tracking_number` string, nullable: Tracking Number associated with the fulfillment - `tracking_company` string, nullable: Tracking company responsible for the fulfillment - `type` 'manual' | 'shipit' | 'chilexpress' | 'ctt' | 'correos_chile' | 'dhl' | 'servientrega' | 'starken' | 'bluexpress' | 'starken_valorado' | 'external' | 'courier' | 'dpd' | 'pedidos_ya' | 'mrw' | 'correos_express' | 'fedex': Type of fulfillment Service used - `shipment_status` 'requested' | 'in_transit' | 'delivered' | 'failed' | 'pickup_available' | 'in_preparation', nullable: Status of the fulfillment - `expected_arrival_from` string, nullable: First date expected for the fulfillment to arrive at customer place - `expected_arrival_to` string, nullable: Last date expected for the fulfillment to arrive at customer place - `order_id` integer, nullable: Identifier of the order - `order` OrderFields - `id` integer: Unique identifier of the Order - `source` TrafficSource - `created_from` string: From where the order was created: [checkout, api, admin, duplicate, recovery, pos] - `created_from_app_code` string: The code of the app that created the order if it was created by an app through the API - `source_name` string: Where the checkout originated - `medium` string: The medium that referred the customer to the checkout - `campaign` string: The campaign that referred the customer to the checkout - `referral_url` string: The website that referred the customer to the checkout - `referral_code` string: The code that referred the customer to the checkout - `user_agent` string: User agent of the referred request to checkout - `first_page_visited` string: The first url visited by the customer - `first_page_visited_at` string: The date when the customer visited the first page - `referral_source` string: The source that referred the customer to the website - `created_at` string: Order date - `completed_at` string: The date when the order was first completed. - `currency` string: Currency of the Order - `subtotal` number, float: Subtotal value for the given Order. Excluding taxes, shipping and discounts - `tax` number, float: Tax value for the given order - `shipping_tax` number, float: Shipping Tax value for the given order - `shipping` number, float: Shipping value for the given Order - `shipping_required` boolean: False if the order is digital. - `total` number, float: Total value for the given Order. Including taxes, shipping and discounts - `discount` number, float: Discount value for the given Order - `shipping_discount` number, float: Shipping Discount value for the given order - `gift_cards_discount` number, float: Gift Cards Discount value for the given order - `fulfillment_status` 'unfulfilled' | 'partial' | 'fulfilled': Fulfillment Status for Order. - `shipping_method_id` integer: Shipping method e.g. Royal Mail - `shipping_service_id` integer: Shipping service - `shipping_method_name` string: Shipping method e.g. Royal Mail - `payment_method_name` string: Payment Method name used e.g. PayPal - `payment_method_type` string: Payment Method type used e.g. paypal - `payment_information` string: Payment information for the given Order - `payment_notification_id` string: Payment notification identifier - `additional_information` string: Additional information for the given Order - `duplicate_url` string: Duplicate Order URL for the given Order - `recovery_url` string: Recovery Order URL for the given Order - `review_url` string: Review Order URL for the given Order - `checkout_url` string: Store Checkout Order URL for the given Order - `coupons` string: Promotion Coupons used on the given Order, separated by commas - `promotions` object[]: Promotions used on the given Order - `id` integer: Id of the Promotion - `name` string - `code` string, nullable: Coupon code used, if any - `customer` CustomerSimpleFields - `id` integer: Unique identifier of the Customer - `email` string: Email of the Customer - `phone` string: Phone of the Customer - `phone_prefix` string: Phone prefix of the Customer - `ip` string: IP of the Customer - `fullname` string: Customer fullname retrieved from the default billing address. Defaults to customer email if no name is found. - `shipping_branch` OrderShippingBranch - `id` integer: ID of the Order's Shipping Branch - `name` string: Name of the Order's Shipping Branch - `shipping_address` OrderShippingAddress - `name` string: Name of the Order's Shipping Address - `surname` string: Surname of the Order's Shipping Address - `address` string: Address of the Order's Shipping Address - `city` string: City of the Order's Shipping Address - `postal` string: Postal code of the Order's Shipping Address - `region` string: Region name of the Order's Shipping Address - `country` string: Country name of the Order's Shipping Address - `country_code` string: Country code of the Order's Shipping Address (ISO 3166-1 alpha-2) - `region_code` string: Region code of the Order's Shipping Address (Use the FIPS standard - http://www.geonames.org/countries/) - `street_number` string: Street number of the Order's Shipping Address - `complement` string: Complement of the Order's Shipping Address - `latitude` number: Latitude of the Order's Shipping Address - `longitude` number: Longitude of the Order's Shipping Address - `municipality` string: Municipality of the Order's Shipping Address - `neighbourhood` string: Third level of administrative subdivision of the Customer's Shipping Address used only for some countries (e.g. Mexico) - `billing_address` OrderBillingAddress - `name` string: Name of the Order's Billing Address - `surname` string: Surname of the Order's Billing Address - `taxid` string: TaxID of the Order's Billing Address - `address` string: Address of the Order's Billing Address - `city` string: City of the Order's Billing Address - `postal` string: Postal code of the Order's Billing Address - `region` string: Region name of the Order's Billing Address - `country` string: Country name of the Order's Billing Address - `country_code` string: Country code of the Order's Billing Address (ISO 3166-1 alpha-2) - `region_code` string: Region code of the Order's Billing Address (Use the FIPS standard - http://www.geonames.org/countries/) - `street_number` string: Street number of the Order's Billing Address - `complement` string: Complement of the Order's Billing Address - `municipality` string: Municipality of the Order's Billing Address - `neighbourhood` string: Third level of administrative subdivision of the Order's Billing Address used only for some countries (e.g. Mexico) - `pickup_address` OrderPickupAddress - `name` string: Name of the Order's Pickup Address - `surname` string: Surname of the Order's Pickup Address - `address` string: Address of the Order's Pickup Address - `city` string: City of the Order's Pickup Address - `postal` string: Postal code of the Order's Pickup Address - `region` string: Region name of the Order's Pickup Address - `country` string: Country name of the Order's Pickup Address - `country_code` string: Country code of the Order's Pickup Address (ISO 3166-1 alpha-2) - `region_code` string: Region code of the Order's Pickup Address (Use the FIPS standard - http://www.geonames.org/countries/) - `street_number` string: Street number of the Order's Pickup Address - `complement` string: Complement of the Order's Pickup Address - `municipality` string: Municipality of the Order's Pickup Address - `pickup_place_name` string: Name of the Pickup Place - `taxid` string: TaxID of the Order's Pickup Address - `neighbourhood` string: Third level of administrative subdivision used only for some countries (e.g. Mexico) - `products` OrderProduct[]: Products of the Order. Deposits and other fees are not product lines: read them from `fees`. - `id` integer, nullable: Unique identifier of the original Product - `order_product_id` integer: Unique identifier of the product line in the Order - `bundle_order_product_id` integer, nullable: Identifier of the bundle product line that contains this product line - `variant_id` integer, nullable: Unique identifier of the original Product Variant - `sku` string: Stock Keeping Unit of the Order Product - `name` string: Name of the Order Product, including the selected options - `qty` integer: Quantity of the Order Product - `price` number, float: Price of the Order Product - `tax` number, float, nullable: Tax of the Order Product - `discount` number, float: Discount of the Order Product - `weight` number, float: Weight of the Order Product - `image` string, nullable: Image URL of the Order Product - `type` 'physical' | 'digital' | 'gift_card' | 'appointment' | 'bundle': Type of the Order Product - `taxes` OrderProductTax[] - `id` integer: Unique identifier of the Order Product Tax - `name` string: Name of the category that the tax is associated with or the tax name - `rate` number, float: Tax rate - `fixed` boolean: False if rate is a percentage and true if rate is monetary - `tax_on_product_price` boolean: False if tax is not included on product price - `amount` number, float: Tax amount charged on the Order Product - `options` object[]: Options selected for the Order Product - `name` string - `value` string - `addon_price` number, float - `stock_locations` OrderProductStockLocations[] - `location_id` integer: Unique identifier of the Order Product Location - `stock` integer: Quantity in stock for the product at the location - `files` object[]: Files uploaded by the customer for file options - `option` string: Name of the file option - `url` string: Temporary URL of the file - `additional_fields` OrderAdditionalFields[]: Array of additional fields for the given Order - `label` string, string: Label of the additional field - `value` string, string: Value of the additional field - `id` integer, nullable: Id of the checkout custom field, if any. Ignored on create and update. - `area` 'contact' | 'shipping' | 'billing' | 'other': Area of the additional field - `shipping_taxes` OrderShippingTax[]: Taxes applied to shipping (returned with the `taxes` field) - `id` integer: Unique identifier of the Order Shipping Tax - `name` string: Tax name - `rate` number, float: Tax rate - `fixed` boolean: False if rate is a percentage and true if rate is monetary - `amount` number, float: Tax amount charged on shipping - `tax_on_shipping_price` boolean: False if shipping tax is not included on shipping price - `fees` OrderFee[]: Fees charged apart from products, shipping and tax, like packaging deposits. They are added to `total` and are not part of `tax`. - `id` integer: Unique identifier of the Order Fee - `kind` 'deposit': Kind of fee - `name` string: Fee name - `order_product_id` integer, nullable: Product line of the Order the fee is charged on. `null` when it applies to the whole Order. - `rate` number, float: Amount per unit, or a percentage of the unit price before tax when `fixed` is false - `fixed` boolean: False if rate is a percentage and true if rate is monetary - `quantity` integer: Number of units charged - `amount` number, float: Fee amount for the whole line, before tax - `tax_amount` number, float: Tax charged on the fee. Always 0 for now: once fees can be taxed, it will also be counted in the Order `tax`. - `status` 'Created' | 'Abandoned' | 'Canceled' | 'Pending Payment' | 'Paid': Status of the Order. - `status_name` 'Created' | 'Abandoned' | 'Canceled' | 'Pending Payment' | 'Paid': Status of the Order (same value as `status`). - `tracking_url` string: Tracking URL for Order Fulfillment. - `tracking_company` string: Company Used for Order Fulfillment. - `tracking_number` string: Tracking Number for Order Fulfillment. - `shipping_option` 'delivery' | 'store_pickup' | 'no_shipping' | 'point_pickup', nullable: Shipping option for this order. - `same_day_delivery` boolean: True if same day delivery was selected for the order, false otherwise. - `shipment_status` string: Shipment Status for Order and Order Fulfillment, translated to the request locale, e.g. `Delivered`, `In Transit`, `Unfulfilled` or `Not Applicable`. Use `shipment_status_enum` for a stable value. - `shipment_status_enum` 'unfulfilled' | 'requested' | 'in_transit' | 'delivered' | 'failed' | 'pickup_available' | 'in_preparation' | 'fulfilled' | 'not_applicable': Shipment Status for Order and Order Fulfillment (enum). `fulfilled` is a fulfillment without a shipment status; `not_applicable` an Order without shipping. - `recovered_from` integer, nullable: Id of the Order this Order was recovered from - `external_shipping_rate_id` string: Rate id for selected External Shipping Method rate - `external_shipping_rate_description` string: Rate description for selected External Shipping Method rate - `billing_information` BillingInformationFields - `business_activity` string: Giro - `company_name` string: Razon Social - `taxpayer_type` string: Tipo de Contribuinte - `cart_id` integer: Internal id of the Order, used as the cart id by `GET /carts/{id}.json`. Only returned when requested with `fields`. - `fulfillment_address` FulfillmentAddress - `name` string: Name of the Fulfillment's Address - `surname` string: Surname of the Fulfillment's Address - `address` string: Address of the Fulfillment's Address - `city` string: City of the Fulfillment's Address - `postal` string: Postal code of the Fulfillment's Address - `municipality` string: Municipality of the Fulfillment's Address - `region` string: Region code of the Fulfillment's Address (Use the FIPS standard - http://www.geonames.org/countries/) - `country` string: Country code of the Fulfillment's Address (ISO 3166-1 alpha-2) - `taxid` string: TaxID of the Fulfillment's Address - `neighbourhood` string: Third level of administrative subdivision used only for some countries (e.g. Mexico) - `default` boolean: True if it is the primary address - `label_url` string: Temporary Url of the Label (available for 24 hours). Empty when there is no label. ## Changes - **2026-11-02** `09f991a20d74`: 2 info - added the optional property `order_fulfillments/items/order/allOf[#/components/schemas/OrderFields]/fees` to the response with the `200` status - removed the `volta` enum value from the `order_fulfillments/items/order/allOf[#/components/schemas/OrderFields]/products/items/type` response property for the response status `200` - **2026-10-15** `53dc9f2c1329`: 1 info - endpoint added [Operation history](https://skmtc.dev/jumpseller/apis/jumpseller-api/changes/fulfillments/search.json/get.md) --- [API](https://skmtc.dev/jumpseller/apis/jumpseller-api.md) - [All operations](https://skmtc.dev/jumpseller/apis/jumpseller-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpseller/apis/jumpseller-api/revisions/09f991a20d74?raw)