OrdersDraft orders

Get Many Draft Orders

Get multiple draft orders with pagination and filtering

GET
/shipos/draft-orders
x-access-token<token>

In: header

Query Parameters

page?number

Page number for pagination (starting from 0)

Formatdouble
Default0
limit?number

Number of items per page

Formatdouble
Default20
search?string

Search term to filter draft orders by draft number or notes

Default""
status?string

Filter by draft order status (comma-separated for multiple)

Default""
order_by?string

Field to order results by

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
  • "draft_number"
order?string

Order direction

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/shipos/draft-orders"
{  "data": [    {      "id": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "status": "OPEN",      "draft_number": "string",      "line_item_hash": "string",      "currency": "string",      "total_price": 0.1,      "total_tax": 0.1,      "total_discount": 0.1,      "total_shipping": 0.1,      "total_outstanding": 0.1,      "presentment_currency_code": "string",      "subtotal_price": 0.1,      "invoice_email_template_subject": "string",      "market_name": "string",      "market_region_country_code": "string",      "shipping_address_name": "string",      "shipping_address_phone": "string",      "shipping_address_company": "string",      "shipping_address_address1": "string",      "shipping_address_address2": "string",      "shipping_address_city": "string",      "shipping_address_state": "string",      "shipping_address_zip": "string",      "shipping_address_country": "string",      "billing_address_name": "string",      "billing_address_phone": "string",      "billing_address_company": "string",      "billing_address_address1": "string",      "billing_address_address2": "string",      "billing_address_city": "string",      "billing_address_state": "string",      "billing_address_zip": "string",      "billing_address_country": "string",      "notes": "string",      "config": {        "require_pack_shot": true,        "show_unfulfilled_items_on_packing_list": true,        "show_prices_on_packing_slip": true,        "tote_qa_enabled": true,        "address_verification_enabled": true,        "incoterm": "FAS",        "incoterm_location": "string",        "eel_pfc": "string",        "delivery_confirmation": "NO_SIGNATURE",        "saturday_delivery": true,        "insurance_policy": {          "mode": "none"        },        "customs_signer": "string",        "customs_signer_title": "string",        "customs_certify": true,        "non_delivery_option": "ABANDON",        "restriction_type": "NONE",        "restriction_comments": "string",        "contents_type": "OTHER",        "contents_explanation": "string",        "commercial_invoice_transaction_reason": "SALE",        "declaration": "string",        "commercial_invoice_payment_terms": "string",        "commercial_invoice_transport_mode": "string",        "commercial_invoice_port_of_entry": "string",        "commercial_invoice_country_of_transshipment": "string",        "commercial_invoice_package_marks": "string",        "commercial_invoice_freight_amount": 0,        "commercial_invoice_discount_amount": 0,        "commercial_invoice_other_charge_amount": 0,        "commercial_invoice_other_charge_description": "string",        "commercial_invoice_importer_tax_id": "string",        "commercial_invoice_importer_vat": "string",        "commercial_invoice_importer_eori": "string",        "commercial_invoice_importer_ioss": "string",        "commercial_invoice_vat_statement": "string",        "commercial_invoice_export_license_number": "string",        "destination_control_statement_required": true      },      "po_number": "string",      "remote_id": "string",      "synced_at": "2019-08-24T14:15:22Z",      "invoice_url": "string",      "invoice_sent_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z",      "ready": true,      "visible_to_customer": true,      "customer_email": "string",      "customer_phone": "string",      "customer_name": "string",      "deliver_by": "2019-08-24T14:15:22Z",      "tax_exempt": true,      "taxes_included": true,      "accept_automatic_discounts": true,      "allow_discount_codes_in_checkout": true,      "reserved_inventory_until": "2019-08-24T14:15:22Z",      "payment_terms_type": "FIXED",      "payment_terms_name": "string",      "payment_terms_due_in_days": 0,      "shop_id": "string",      "merchant_team_id": "string",      "team_id": "string",      "order_id": "string",      "shop_name": "string",      "shop_type": "SHOPIFY",      "shop_slug": "string",      "merchant_team_name": "string",      "team_name": "string",      "fulfiller_team_id": "string",      "fulfiller_team_name": "string",      "tags": [        "string"      ],      "core_line_item_count": 0.1,      "unique_core_line_item_count": 0.1,      "supported_actions": [        {          "action": "VIEW_DRAFT_ORDER"        }      ]    }  ],  "meta": {    "page": 0.1,    "page_size": 0.1,    "has_next_page": true,    "has_previous_page": true,    "start_index": 0.1,    "end_index": 0.1  }}