Sign in
latestSwagger 2.0ShopBase Dev 1.02026-08-10153268547.4 KB

353ccde6240d

Order

Retrieves a list of orders

Retrieve all orders

get/admin/orders.json

Request body

chargeback_deadline_at_maxstring

Show orders chargeback deadline at or before date. (format: 2014-04-25T16:15:47-04:00)

chargeback_deadline_at_minstring

Show orders chargeback deadline at or after date. (format: 2014-04-25T16:15:47-04:00)

chargeback_statusstring

Filter orders by their chargeback status, specified by a comma-separated list of statuses. </br>Acceptable value: open, submitted, won, lost.

created_at_maxstring

Show orders created at or before date. (format: 2014-04-25T16:15:47-04:00)

created_at_minstring

Show orders created at or after date. (format: 2014-04-25T16:15:47-04:00)

customer_emailstring

Filter orders by their customer email.

customer_idinteger

ID of customer

fieldsstring

Retrieve only certain fields, specified by a comma-separated list of fields names.

filter_order_riskboolean

Filter orders by risk level.

financial_statusstring

Filter orders by their financial status, specified by a comma-separated list of statuses. </br>authorized: Show only authorized orders. </br>pending: Show only pending orders. </br>paid: Show only paid orders. </br>partially_paid: Show only partially paid orders. </br>refunded: Show only refunded orders. </br>partially_refunded: Show only partially refunded orders. </br>unpaid: Show authorized and partially paid orders. </br>voided: Show only voided orders. </br>any: Show orders of any financial status.

fulfilled_at_maxstring

Show orders fulfilled at or before date. (format: 2014-04-25T16:15:47-04:00)

fulfilled_at_minstring

Show orders fulfilled at or after date. (format: 2014-04-25T16:15:47-04:00)

fulfillment_servicestring

Filter orders by their fulfillment service handle, specified by a comma-separated list of services.

fulfillment_statusstring

Filter orders by their fulfillment status, specified by a comma-separated list of statuses. </br>fulfilled: Show orders that have been shipped (alias: shipped). </br>partial: Show partially shipped orders. </br>unfulfilled: Show orders that have not yet fulfilled or partial (alias: unshipped). </br>any: Show orders of any fulfillment status. </br>restocked: Show order that have been restocked. </br>processing: Show order that in processing. </br>partial-processing: Show partially processing orders.

idsinteger[]

List of order ID

limitinteger

The maximum number of results to show on a page. (default: 50, maximum: 250)

not_product_mappingboolean

Filter order by line item's product not mapped.

not_product_namestring

Filter orders by line item's product name which not contains.

not_product_skustring

Filter orders by line item's product sku which not contains.

not_product_typestring

Filter orders by line item's product type which not contains.

not_product_vendorstring

Filter orders by line item's product vendor which not contains.

order_statusstring

Filter orders by their status, specified by a comma-separated list of statuses. </br>open: Show only open orders. </br>closed: Show only closed orders. </br>cancelled: Show only canceled orders. </br>any: Show orders of any status, including archived orders.

pageinteger

Number of page.

product_mappingboolean

Filter order by line item's product mapped.

product_namestring

Filter orders by line item's product name which contains.

product_skustring

Filter orders by line item's product sku which contains.

product_typestring

Filter orders by line item's product type which contains.

product_vendorstring

Filter orders by line item's product vendor which contains.

since_idinteger

Show orders after the specified ID.

tagstring

Filter order by tag.

tracking_numberstring

Filter order by transaction number.

updated_at_maxstring

Show orders last updated at or before date (format: 2019-04-22T16:15:47-04:00).

updated_at_minstring

Show orders last updated at or after date (format: 2019-04-22T16:15:47-04:00).

Example request

{
  "chargeback_deadline_at_max": "2014-04-25T16:15:47-04:00",
  "chargeback_deadline_at_min": "2014-04-25T16:15:47-04:00",
  "chargeback_status": "submitted",
  "created_at_max": "2014-04-25T16:15:47-04:00",
  "created_at_min": "2014-04-25T16:15:47-04:00",
  "customer_email": "example@shopbase.com",
  "customer_id": 1234567,
  "fields": "id",
  "financial_status": "authorized,pending",
  "fulfilled_at_max": "2014-04-25T16:15:47-04:00",
  "fulfilled_at_min": "2014-04-25T16:15:47-04:00",
  "fulfillment_status": "fulfilled",
  "ids": [
    23556,
    12345
  ],
  "limit": 50,
  "not_product_name": "jean",
  "not_product_sku": "esku-1234566",
  "not_product_type": "cute",
  "not_product_vendor": "example-not-vendor",
  "order_status": "open",
  "page": 1,
  "product_name": "t-shirt",
  "product_sku": "sku-11223344",
  "product_type": "camping",
  "product_vendor": "example-vendor",
  "since_id": 11102323,
  "tag": "Invalid address",
  "tracking_number": "LO123456789CN",
  "updated_at_max": "2019-04-22T16:15:47-04:00",
  "updated_at_min": "2019-04-22T16:15:47-04:00"
}

Response

OK