object MergeableOrder

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

order_numberString

The store's internal order number.

partner_order_idString

The order ID assigned by the storefront.

shop_nameString

Shop name for this order.

fulfillment_statusString

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

order_dateISODateTime

Order date in ISO-8601 date or datetime format, returned in UTC when time is included.

total_taxString

Monetary amount as a decimal value in the record currency; not cents.

subtotalString

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

total_discountsString

Monetary amount as a decimal value in the record currency; not cents.

total_priceString

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

box_nameString

Box name for this order.

ready_to_shipBooleanDEPRECATED This field is no longer being updated and should not be used or relied on

Deprecated ready-to-ship flag; this field is no longer updated reliably.

auto_print_return_labelBoolean

Whether a return label should be printed automatically for this order.

custom_invoice_urlString

URL for the custom invoice URL resource.

account_idString

Public API account ID that identifies the related record.

updated_atISODateTime

Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

created_atISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

emailString

Email address for the contact.

profileString

Profile for this order.

gift_noteString

Gift note for this order.

packing_noteString

Packing note for this order.

required_ship_dateISODateTime

Required ship date in ISO-8601 date or datetime format, returned in UTC when time is included.

shipping_linesShippingLines

Shipping lines for this order.

shipping_addressOrderAddress

Shipping address details for this order.

billing_addressOrderAddress

Billing address details for this order.

tags[String]

List of tags for this order.

line_itemsLineItemQuerySpecConnection

List of line items associated with this order.

ArgumentTypeRequiredDefaultDescription
sortStringNo
searchGenericScalarNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo
authorizations[Authorization]

List of authorizations for this order.

holdsOrderHolds

Holds for this order.

shipments[Shipment]

List of shipments for this order.

returns[Return]

List of returns for this order.

rma_labels[RMALabel]

List of RMA labels for this order.

flaggedBoolean

Whether this order is flagged for attention.

saturday_deliveryBoolean

Whether Saturday delivery is requested for this order.

ignore_address_validation_errorsBoolean

Whether to ignore address validation errors for this order.

skip_address_validationBoolean

Whether to skip address validation for this order.

priority_flagBoolean

Whether this order is marked as priority.

allocation_priorityInt

Allocation priority as a numeric value.

allocations[OrderWarehouseAllocation]

List of allocations for this order.

sourceString

Source for this order.

third_party_shipperOrderThirdPartyShipper

Third party shipper for this order.

gift_invoiceBoolean

Whether this order should use a gift invoice.

allow_partialBoolean

True when this order allows partial; false otherwise.

require_signatureBoolean

Whether this order requires a delivery signature.

adult_signature_requiredBoolean

Whether this order requires an adult delivery signature.

alcoholBoolean

Whether this order contains alcohol and requires alcohol shipping handling.

expected_weight_in_ozString

Expected weight in oz in ounces.

insuranceBoolean

Whether shipping insurance is enabled for this order.

insurance_amountString

Monetary amount as a decimal value in the record currency; not cents.

currencyString

ISO 4217 currency code for the monetary values on this order.

has_dry_iceBoolean

True when this order has dry ice; false otherwise.

allow_splitBoolean

True when this order allows split; false otherwise.

hold_until_dateISODateTime

Hold until date in ISO-8601 date or datetime format, returned in UTC when time is included.

incotermsString

Incoterms for this order.

tax_idString

Public API tax ID that identifies the related record.

tax_typeString

Tax type for this order.

dry_ice_weight_in_lbsString

Dry ice weight in lb in pounds.

ftr_exemptionDecimalDEPRECATED Use ftr_exemption_value instead

Foreign Trade Regulations exemption value. Deprecated; use ftr_exemption_value.

ftr_exemption_valueString

Foreign Trade Regulations exemption value used for export documentation.

address_is_businessBoolean

Whether the ship-to address is a business address.

tote_qaBoolean

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

do_not_print_invoiceBoolean

Whether invoices should be suppressed when printing documents for this order.

ignore_payment_capture_errorsBoolean

Whether to ignore payment capture errors for this order.

service_point_idString

Public API service point ID that identifies the related record.

partner_source_nameString

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

order_history[OrderHistory]

List of order history for this order.

merged_orders[MergedOrder]

List of merged orders for this order.

attachmentsOrderAttachmentQuerySpecConnection

List of attachments associated with this order.

ArgumentTypeRequiredDefaultDescription
sortStringNo
searchGenericScalarNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo
wholesale_orderWholesaleOrder

Wholesale order associated with this order.

potential_merges[Order]

List of potential merges for this mergeable order.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "order_number": "SO-100045",
  "partner_order_id": "SHOPIFY-100045",
  "shop_name": "SO-100045",
  "fulfillment_status": "pending",
  "order_date": "2026-07-09T15:30:00Z",
  "total_tax": "19.99",
  "subtotal": "19.99",
  "total_discounts": "19.99",
  "total_price": "19.99",
  "box_name": "SO-100045",
  "ready_to_ship": true,
  "auto_print_return_label": true,
  "custom_invoice_url": "https://example.com/resource",
  "account_id": "QWNjb3VudDoxMjM0",
  "updated_at": "2026-07-09T15:30:00Z",
  "created_at": "2026-07-09T15:30:00Z",
  "email": "customer@example.com",
  "profile": "default",
  "gift_note": "Customer requested expedited handling.",
  "packing_note": "Customer requested expedited handling.",
  "required_ship_date": "2026-07-09T15:30:00Z",
  "shipping_lines": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "shipping_address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "billing_address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "tags": ["priority", "vip"],
  "line_items": [{sku: "BLUE-TEE-M", quantity: 2}],
  "authorizations": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "holds": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "shipments": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "returns": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "rma_labels": ["RMA"],
  "flagged": true,
  "saturday_delivery": true,
  "ignore_address_validation_errors": false,
  "skip_address_validation": false,
  "priority_flag": true,
  "allocation_priority": 1,
  "allocations": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "source": "shopify",
  "third_party_shipper": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "gift_invoice": true,
  "allow_partial": true,
  "require_signature": true,
  "adult_signature_required": true,
  "alcohol": true,
  "expected_weight_in_oz": "1.25",
  "insurance": true,
  "insurance_amount": "19.99",
  "currency": "19.99",
  "has_dry_ice": true,
  "allow_split": true,
  "hold_until_date": "2026-07-09T15:30:00Z",
  "incoterms": "DAP",
  "tax_id": "T3JkZXI6MTIzNA==",
  "tax_type": "19.99",
  "dry_ice_weight_in_lbs": "1.25",
  "ftr_exemption": 1.5,
  "ftr_exemption_value": "19.99",
  "address_is_business": true,
  "tote_qa": true,
  "do_not_print_invoice": false,
  "ignore_payment_capture_errors": false,
  "service_point_id": "T3JkZXI6MTIzNA==",
  "partner_source_name": "shopify",
  "order_history": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "merged_orders": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "attachments": [{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}],
  "wholesale_order": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "potential_merges": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]]
}