object MergeableOrder

Fields

FieldTypeDescription
idString
legacy_idInt
order_numberString

The store's internal order number

partner_order_idString

The order ID assigned by the storefront

shop_nameString
fulfillment_statusString

Status of the order (pending, fulfilled, cancelled, etc)

order_dateISODateTime
total_taxString
subtotalString
total_discountsString
total_priceString
box_nameString
ready_to_shipBooleanDEPRECATED This field is no longer being updated and should not be used or relied on
auto_print_return_labelBoolean
custom_invoice_urlString
account_idString
updated_atISODateTime
created_atISODateTime
emailString
profileString
gift_noteString
packing_noteString
required_ship_dateISODateTime
shipping_linesShippingLines
shipping_addressOrderAddress
billing_addressOrderAddress
tags[String]
line_itemsLineItemQuerySpecConnection
ArgumentTypeRequiredDefaultDescription
sortStringNo
searchGenericScalarNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo
authorizations[Authorization]
holdsOrderHolds
shipments[Shipment]
returns[Return]
rma_labels[RMALabel]
flaggedBoolean
saturday_deliveryBoolean
ignore_address_validation_errorsBoolean
skip_address_validationBoolean
priority_flagBoolean
allocation_priorityInt
allocations[OrderWarehouseAllocation]
sourceString
third_party_shipperOrderThirdPartyShipper
gift_invoiceBoolean
allow_partialBoolean
require_signatureBoolean
adult_signature_requiredBoolean
alcoholBoolean
expected_weight_in_ozString
insuranceBoolean
insurance_amountString
currencyString
has_dry_iceBoolean
allow_splitBoolean
hold_until_dateISODateTime
incotermsString
tax_idString
tax_typeString
dry_ice_weight_in_lbsString
ftr_exemptionDecimal
address_is_businessBoolean
tote_qaBoolean

Requires users to scan and verify all items from a tote before shipping

do_not_print_invoiceBoolean
ignore_payment_capture_errorsBoolean
partner_source_nameString

Partner source identifier (e.g., web, pos, shopify_draft_order, etc.)

order_history[OrderHistory]
merged_orders[MergedOrder]
attachmentsOrderAttachmentQuerySpecConnection
ArgumentTypeRequiredDefaultDescription
sortStringNo
searchGenericScalarNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo
wholesale_orderWholesaleOrder
potential_merges[Order]

Referenced By

Example

{
  "id": "abc123",
  "legacy_id": 987,
  "order_number": "abc123",
  "partner_order_id": "abc123",
  "shop_name": "abc123",
  "fulfillment_status": "abc123",
  "order_date": "abc123",
  "total_tax": "abc123",
  "subtotal": "abc123",
  "total_discounts": "abc123",
  "total_price": "abc123",
  "box_name": "abc123",
  "ready_to_ship": true,
  "auto_print_return_label": true,
  "custom_invoice_url": "abc123",
  "account_id": "abc123",
  "updated_at": "abc123",
  "created_at": "abc123",
  "email": "abc123",
  "profile": "abc123",
  "gift_note": "abc123",
  "packing_note": "abc123",
  "required_ship_date": "abc123",
  "shipping_lines": ShippingLines,
  "shipping_address": OrderAddress,
  "billing_address": OrderAddress,
  "tags": "abc123",
  "line_items": LineItemQuerySpecConnection,
  "authorizations": Authorization,
  "holds": OrderHolds,
  "shipments": Shipment,
  "returns": Return,
  "rma_labels": RMALabel,
  "flagged": true,
  "saturday_delivery": true,
  "ignore_address_validation_errors": true,
  "skip_address_validation": true,
  "priority_flag": true,
  "allocation_priority": 987,
  "allocations": OrderWarehouseAllocation,
  "source": "abc123",
  "third_party_shipper": OrderThirdPartyShipper,
  "gift_invoice": true,
  "allow_partial": true,
  "require_signature": true,
  "adult_signature_required": true,
  "alcohol": true,
  "expected_weight_in_oz": "abc123",
  "insurance": true,
  "insurance_amount": "abc123",
  "currency": "abc123",
  "has_dry_ice": true,
  "allow_split": true,
  "hold_until_date": "abc123",
  "incoterms": "abc123",
  "tax_id": "abc123",
  "tax_type": "abc123",
  "dry_ice_weight_in_lbs": "abc123",
  "ftr_exemption": "abc123",
  "address_is_business": true,
  "tote_qa": true,
  "do_not_print_invoice": true,
  "ignore_payment_capture_errors": true,
  "partner_source_name": "abc123",
  "order_history": OrderHistory,
  "merged_orders": MergedOrder,
  "attachments": OrderAttachmentQuerySpecConnection,
  "wholesale_order": WholesaleOrder,
  "potential_merges": Order
}