Skip to main content
GET
/
v1
/
shipping
/
orders
List all Orders
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/shipping/orders \
  --header 'Authorization: Bearer <token>'
{
  "collection": [
    {
      "type": "Order",
      "id": 3,
      "unique_id": "1100000003",
      "order_ref": "O-382227",
      "state": "new",
      "status": "new",
      "brand": {
        "type": "Brand",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "is_active": true,
        "is_deleted": false,
        "sort_order": 0
      },
      "merchant": {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      },
      "carrier_code": "fedex",
      "shipping_method": "fedex_FEDEX_2_DAY",
      "signature_required": "adult",
      "is_saturday_delivery": false,
      "is_overbox_required": false,
      "priority": 50,
      "requested_ship_date": "2021-02-21",
      "is_declared_value_service": true,
      "declared_value": {
        "amount": 99,
        "currency": "USD"
      },
      "shipping_address": {
        "type": "OrderAddress",
        "id": 4,
        "first_name": "Celina",
        "last_name": "Goalley",
        "company": "Thompson-Torp",
        "street": [
          "15491 West Whiteside Street"
        ],
        "city": "Springfield",
        "region": "MO",
        "postcode": "65807",
        "country": "US",
        "telephone": "(417) 123-4567",
        "email": "[email protected]",
        "classification": "residential",
        "is_valid": true
      },
      "items": [
        {
          "type": "OrderItem",
          "id": 4,
          "sku": "KDS2108",
          "order_item_ref": "<string>",
          "product": {
            "type": "Product",
            "id": 123
          },
          "qty_ordered": 4,
          "qty_assigned": 4,
          "qty_allocated": 0,
          "qty_backordered": 0,
          "qty_processing": 0,
          "qty_picked": 0,
          "qty_shipped": 4,
          "qty_cancel_requested": 0,
          "qty_canceled": 0,
          "row_weight": {
            "value": 20,
            "unit": "lb"
          }
        }
      ],
      "shipments": [
        {
          "type": "Shipment",
          "id": 123
        }
      ],
      "custom_greeting": "<string>",
      "status_history": [
        {
          "type": "OrderStatusHistory",
          "id": 3,
          "status": "new",
          "comment": "Changed shipping method to FedEx Ground",
          "notify_merchant": null,
          "script_id": 123,
          "created_at": "2017-07-21T17:32:28Z"
        }
      ],
      "other_shipping_options": {
        "virtual_excluded_services": [
          "/^ups_/",
          "fedex_FEDEX_2_DAY"
        ]
      },
      "duties_payor": {
        "payor": "third_party",
        "tpb_group_id": 3
      },
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:39:43Z",
      "completed_at": "2017-07-21T17:39:43Z",
      "custom_fields": {
        "is_gift": {
          "value": true
        },
        "order_details": {
          "value": "test details"
        },
        "department": {
          "id": 3,
          "label": "Shipping"
        },
        "priority_levels": [
          {
            "id": 1,
            "label": "Urgent"
          },
          {
            "id": 2,
            "label": "High"
          }
        ],
        "cost_of_goods": {
          "amount": 156.99,
          "currency": "USD"
        },
        "assigned_user": {
          "value": 42
        }
      },
      "weight": {
        "value": 20,
        "unit": "lb"
      },
      "total_item_count": 5,
      "submitted_by": "API Order Import",
      "submitted_by_type": "api",
      "backorder_policy": "default",
      "source": "shopify",
      "customer_note": "Please leave at front door",
      "batch_tag": "BATCH-2024-001",
      "desired_delivery_date": "2024-02-15",
      "can_fulfill": true,
      "can_fulfill_at": "2024-02-10T14:30:00Z",
      "is_address_modified": false,
      "is_address_modified_auto": false,
      "hold_until_time": "2024-02-12T08:00:00Z",
      "tpb_group": {
        "type": "ThirdPartyBillingGroup",
        "id": 1
      },
      "customs_value": {
        "amount": 99,
        "currency": "USD"
      },
      "reason_for_export": "Sale",
      "generate_sscc": [
        "pack"
      ],
      "shipped_at": "2024-02-10T16:45:00Z",
      "delivered_at": "2024-02-12T10:30:00Z",
      "shipping_description": "FedEx 2Day",
      "carrier": "FedEx",
      "allocation_options": {},
      "automation_data": {},
      "original_address": {
        "type": "OrderAddress",
        "id": 4,
        "first_name": "Celina",
        "last_name": "Goalley",
        "company": "Thompson-Torp",
        "street": [
          "15491 West Whiteside Street"
        ],
        "city": "Springfield",
        "region": "MO",
        "postcode": "65807",
        "country": "US",
        "telephone": "(417) 123-4567",
        "email": "[email protected]",
        "classification": "residential",
        "is_valid": true
      },
      "address_candidates": [
        {
          "type": "OrderAddressCandidate",
          "id": 1,
          "street": "15491 W Whiteside St",
          "city": "Springfield",
          "region_code": "MO",
          "postal_code": "65807-1234",
          "country_code": "US",
          "classification": "residential"
        }
      ],
      "instructions": [
        {
          "type": "OrderInstruction",
          "id": 1,
          "note": "Handle with care - fragile items",
          "file_name": "packing-guide.pdf",
          "presentation": "once_per_shipment",
          "print_target": "label",
          "print_orientation": "portrait",
          "copies_printed": 0
        }
      ]
    }
  ],
  "included": {
    "Brand": [
      {
        "type": "Brand",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "is_active": true,
        "is_deleted": false,
        "sort_order": 0
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "Order": [
      {
        "type": "Order",
        "id": 3,
        "unique_id": "1100000003",
        "order_ref": "O-382227",
        "state": "new",
        "status": "new",
        "brand": {
          "type": "Brand",
          "id": 4,
          "code": "acme_inc",
          "name": "ACME Inc.",
          "is_active": true,
          "is_deleted": false,
          "sort_order": 0
        },
        "merchant": {
          "type": "Merchant",
          "id": 4,
          "code": "acme_inc",
          "name": "ACME Inc.",
          "status": "active",
          "created_at": "2017-07-21T17:32:28Z",
          "updated_at": "2017-07-21T17:39:43Z",
          "brands": [
            {
              "type": "Brand",
              "id": 4
            }
          ],
          "default_brand": {
            "type": "Brand",
            "id": 4
          }
        },
        "carrier_code": "fedex",
        "shipping_method": "fedex_FEDEX_2_DAY",
        "signature_required": "adult",
        "is_saturday_delivery": false,
        "is_overbox_required": false,
        "priority": 50,
        "requested_ship_date": "2021-02-21",
        "is_declared_value_service": true,
        "declared_value": {
          "amount": 99,
          "currency": "USD"
        },
        "shipping_address": {
          "type": "OrderAddress",
          "id": 4,
          "first_name": "Celina",
          "last_name": "Goalley",
          "company": "Thompson-Torp",
          "street": [
            "15491 West Whiteside Street"
          ],
          "city": "Springfield",
          "region": "MO",
          "postcode": "65807",
          "country": "US",
          "telephone": "(417) 123-4567",
          "email": "[email protected]",
          "classification": "residential",
          "is_valid": true
        },
        "items": [
          {
            "type": "OrderItem",
            "id": 4,
            "sku": "KDS2108",
            "order_item_ref": "<string>",
            "product": {
              "type": "Product",
              "id": 123
            },
            "qty_ordered": 4,
            "qty_assigned": 4,
            "qty_allocated": 0,
            "qty_backordered": 0,
            "qty_processing": 0,
            "qty_picked": 0,
            "qty_shipped": 4,
            "qty_cancel_requested": 0,
            "qty_canceled": 0,
            "row_weight": {
              "value": 20,
              "unit": "lb"
            }
          }
        ],
        "shipments": [
          {
            "type": "Shipment",
            "id": 123
          }
        ],
        "custom_greeting": "<string>",
        "status_history": [
          {
            "type": "OrderStatusHistory",
            "id": 3,
            "status": "new",
            "comment": "Changed shipping method to FedEx Ground",
            "notify_merchant": null,
            "script_id": 123,
            "created_at": "2017-07-21T17:32:28Z"
          }
        ],
        "other_shipping_options": {
          "virtual_excluded_services": [
            "/^ups_/",
            "fedex_FEDEX_2_DAY"
          ]
        },
        "duties_payor": {
          "payor": "third_party",
          "tpb_group_id": 3
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "completed_at": "2017-07-21T17:39:43Z",
        "custom_fields": {
          "is_gift": {
            "value": true
          },
          "order_details": {
            "value": "test details"
          },
          "department": {
            "id": 3,
            "label": "Shipping"
          },
          "priority_levels": [
            {
              "id": 1,
              "label": "Urgent"
            },
            {
              "id": 2,
              "label": "High"
            }
          ],
          "cost_of_goods": {
            "amount": 156.99,
            "currency": "USD"
          },
          "assigned_user": {
            "value": 42
          }
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "total_item_count": 5,
        "submitted_by": "API Order Import",
        "submitted_by_type": "api",
        "backorder_policy": "default",
        "source": "shopify",
        "customer_note": "Please leave at front door",
        "batch_tag": "BATCH-2024-001",
        "desired_delivery_date": "2024-02-15",
        "can_fulfill": true,
        "can_fulfill_at": "2024-02-10T14:30:00Z",
        "is_address_modified": false,
        "is_address_modified_auto": false,
        "hold_until_time": "2024-02-12T08:00:00Z",
        "tpb_group": {
          "type": "ThirdPartyBillingGroup",
          "id": 1
        },
        "customs_value": {
          "amount": 99,
          "currency": "USD"
        },
        "reason_for_export": "Sale",
        "generate_sscc": [
          "pack"
        ],
        "shipped_at": "2024-02-10T16:45:00Z",
        "delivered_at": "2024-02-12T10:30:00Z",
        "shipping_description": "FedEx 2Day",
        "carrier": "FedEx",
        "allocation_options": {},
        "automation_data": {},
        "original_address": {
          "type": "OrderAddress",
          "id": 4,
          "first_name": "Celina",
          "last_name": "Goalley",
          "company": "Thompson-Torp",
          "street": [
            "15491 West Whiteside Street"
          ],
          "city": "Springfield",
          "region": "MO",
          "postcode": "65807",
          "country": "US",
          "telephone": "(417) 123-4567",
          "email": "[email protected]",
          "classification": "residential",
          "is_valid": true
        },
        "address_candidates": [
          {
            "type": "OrderAddressCandidate",
            "id": 1,
            "street": "15491 W Whiteside St",
            "city": "Springfield",
            "region_code": "MO",
            "postal_code": "65807-1234",
            "country_code": "US",
            "classification": "residential"
          }
        ],
        "instructions": [
          {
            "type": "OrderInstruction",
            "id": 1,
            "note": "Handle with care - fragile items",
            "file_name": "packing-guide.pdf",
            "presentation": "once_per_shipment",
            "print_target": "label",
            "print_orientation": "portrait",
            "copies_printed": 0
          }
        ]
      }
    ],
    "OrderAddress": [
      {
        "type": "OrderAddress",
        "id": 4,
        "first_name": "Celina",
        "last_name": "Goalley",
        "company": "Thompson-Torp",
        "street": [
          "15491 West Whiteside Street"
        ],
        "city": "Springfield",
        "region": "MO",
        "postcode": "65807",
        "country": "US",
        "telephone": "(417) 123-4567",
        "email": "[email protected]",
        "classification": "residential",
        "is_valid": true
      }
    ],
    "OrderAddressCandidate": [
      {
        "type": "OrderAddressCandidate",
        "id": 1,
        "street": "15491 W Whiteside St",
        "city": "Springfield",
        "region_code": "MO",
        "postal_code": "65807-1234",
        "country_code": "US",
        "classification": "residential"
      }
    ],
    "OrderInstruction": [
      {
        "type": "OrderInstruction",
        "id": 1,
        "note": "Handle with care - fragile items",
        "file_name": "packing-guide.pdf",
        "presentation": "once_per_shipment",
        "print_target": "label",
        "print_orientation": "portrait",
        "copies_printed": 0
      }
    ],
    "OrderItem": [
      {
        "type": "OrderItem",
        "id": 4,
        "sku": "KDS2108",
        "order_item_ref": "<string>",
        "product": {
          "type": "Product",
          "id": 123
        },
        "qty_ordered": 4,
        "qty_assigned": 4,
        "qty_allocated": 0,
        "qty_backordered": 0,
        "qty_processing": 0,
        "qty_picked": 0,
        "qty_shipped": 4,
        "qty_cancel_requested": 0,
        "qty_canceled": 0,
        "row_weight": {
          "value": 20,
          "unit": "lb"
        }
      }
    ],
    "OrderStatusHistory": [
      {
        "type": "OrderStatusHistory",
        "id": 3,
        "status": "new",
        "comment": "Changed shipping method to FedEx Ground",
        "notify_merchant": null,
        "script_id": 123,
        "created_at": "2017-07-21T17:32:28Z"
      }
    ],
    "PackagingContainer": [
      {
        "type": "PackagingContainer",
        "id": 123,
        "container_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "dimensions": {
            "length": 8,
            "width": 6,
            "height": 4,
            "unit": "in"
          },
          "volume": {
            "value": 300,
            "unit": "in^3"
          },
          "manage_stock": true,
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_warehouses": [
            {
              "type": "Warehouse",
              "id": 123
            }
          ],
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "satisfies_overbox": true,
          "use_for_bin_packing": "yes",
          "weight_capacity": {
            "value": 20,
            "unit": "lb"
          },
          "container_style": "rigid_box",
          "packaging_handling_surcharge": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingDataCollection": [
      {
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "type": "PackagingDataCollection",
        "id": 123,
        "data_collection_options": {
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true,
          "collect_data_pattern": "<string>",
          "apply_to_region": "<string>",
          "is_collected_data_unique": true
        }
      }
    ],
    "PackagingInfill": [
      {
        "type": "PackagingInfill",
        "id": 123,
        "infill_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "manage_stock": true,
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "disable_confirm_button": true,
          "apply_unless_container_meets_hazmat": true,
          "is_confirmation_required": true,
          "infill_horizontal": {
            "value": 12,
            "unit": "in"
          },
          "infill_vertical": {
            "value": 12,
            "unit": "in"
          },
          "infill_priority": 123
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingInstruction": [
      {
        "type": "PackagingInstruction",
        "id": 123,
        "instruction_options": {
          "barcodes": "956623520-4",
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_to_region": "<string>",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingSupplies": [
      {
        "type": "PackagingSupplies",
        "id": 123,
        "supplies_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "manage_stock": true,
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_warehouses": [
            {
              "type": "Warehouse",
              "id": 123
            }
          ],
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "packaging_handling_surcharge": true,
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_to_region": "<string>",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Product": [
      {
        "type": "Product",
        "id": 123,
        "vendor_sku": "Vendor-SKU-1AD2",
        "external_id": "11-993-9048",
        "barcodes": [
          "956623520-4",
          "O-VS-Oregano-p3"
        ],
        "goods_type": "NORMAL",
        "is_available": true,
        "is_visible": true,
        "lot_type": {
          "type": "LotType",
          "id": 4
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "dimensions": {
          "length": 8,
          "width": 6,
          "height": 4,
          "unit": "in"
        },
        "volume": {
          "value": 300,
          "unit": "in^3"
        },
        "inventory": {
          "backorders": true,
          "dynamic_allocation": true,
          "virtual_inventory": "optimistic"
        },
        "export": {
          "description": "Plastic children's toy with steel weights and ball bearings",
          "customs_value": {
            "amount": 99,
            "currency": "USD"
          },
          "country_of_manufacture": "TW",
          "hs_base_code": "8518.30",
          "hs_country_extension": [
            {
              "country_id": "TW",
              "extension": "002"
            },
            {
              "country_id": "US",
              "extension": "011"
            }
          ]
        },
        "regulated_goods": {
          "regulation": {
            "type": "Regulation",
            "id": 123
          },
          "technical_name": "Hydro Polymer Acetylene Coating",
          "additional_information": "Flamable Liquid",
          "net_weight": {
            "value": 20,
            "unit": "lb"
          },
          "container_type": "Plastic Box",
          "container_meets_hazmat_specs": true,
          "regulation_units": 5
        },
        "packaging": {
          "require_packaging": true,
          "require_weight_check": true,
          "require_confirmation_per_item": true,
          "unit_quantity": 1,
          "bulk_quantity": 10,
          "max_per_package": 15,
          "is_ship_separately": true,
          "ship_separately_tag": "PVC",
          "can_tip": true,
          "can_contain_other_items": true,
          "is_handling_surcharge": true
        },
        "custom_fields": [
          {
            "code": "color",
            "value": 13,
            "label": "Red and Black"
          },
          {
            "code": "cost_of_goods",
            "value": 41.32
          },
          {
            "code": "allow_mailer",
            "value": true
          }
        ],
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Shipment": [
      {
        "type": "Shipment",
        "id": 3,
        "unique_id": "1100000003",
        "external_id": "<string>",
        "status": "new",
        "shipping_carrier_code": "fedex",
        "shipping_method": "<string>",
        "shipping_method_name": "<string>",
        "shipping_service_code": "<string>",
        "shipping_service_name": "fedex_FEDEX_2_DAY",
        "warehouse": {
          "type": "Warehouse",
          "id": 123
        },
        "order": {
          "type": "Order",
          "id": 123
        },
        "shipping_account": {
          "type": "ShippingAccount",
          "id": 4
        },
        "target_ship_date": "2023-12-25",
        "item_weight": {
          "value": 20,
          "unit": "lb"
        },
        "shipped_weight": {
          "value": 20,
          "unit": "lb"
        },
        "items": [
          {
            "type": "ShipmentItem",
            "id": 123,
            "product": {
              "type": "Product",
              "id": 3
            }
          }
        ],
        "packages": [
          {
            "items": [
              {
                "sku": "KDS2108",
                "quantity": 2,
                "order_item_id": 4,
                "order_item_sku": "KDS2108",
                "order_item_qty": 2,
                "shipment_item_id": 4,
                "weight": {
                  "value": 20,
                  "unit": "lb"
                },
                "hazmat_unit_weight": {
                  "value": 20,
                  "unit": "lb"
                },
                "total_customs_value": {
                  "amount": 99,
                  "currency": "USD"
                }
              }
            ],
            "packaging": [
              {
                "product": {
                  "type": "Product",
                  "id": 3
                },
                "quantity": 4
              }
            ],
            "collected_data": [
              {
                "order_item_id": 4,
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "created_at": "2017-07-21T17:32:28Z",
            "updated_at": "2017-07-21T17:39:43Z"
          }
        ],
        "packing_solution": {
          "type": "ShipmentPackingSolution",
          "id": 3,
          "containers": [
            {
              "type": "ShipmentPackingSolutionContainer",
              "weight": {
                "value": 20,
                "unit": "lb"
              },
              "dimensions": {
                "length": 8,
                "width": 6,
                "height": 4,
                "unit": "in"
              },
              "volume": {
                "value": 300,
                "unit": "in^3"
              },
              "void_percent": 15.23,
              "regulation_type": "full",
              "items": [
                {
                  "type": "ShipmentPackingSolutionContainerItem",
                  "sku": "KDS2108",
                  "quantity": 2,
                  "order_item_id": 4,
                  "order_item_sku": "KDS2108",
                  "order_item_qty": 2,
                  "shipment_item_id": 4,
                  "weight": {
                    "value": 20,
                    "unit": "lb"
                  }
                }
              ]
            }
          ]
        },
        "picking_class_id": "Default",
        "is_cutoff_date_exception": true,
        "is_manually_processed": true,
        "label_print_target": "label001",
        "scac": "FDEG",
        "carrier_shipping_cost": 3.9,
        "is_international": true,
        "is_documents_required": true,
        "is_electronic_customs": true,
        "infill_product_id": "kraft",
        "max_package_weight": 2.5,
        "packing_solution_providers": [
          "Provider 1",
          "Provider 2"
        ],
        "tpb_group": "ACME Inc",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "packed_at": "2017-07-21T17:32:28Z",
        "total_weight": {
          "value": 20,
          "unit": "lb"
        }
      }
    ],
    "ShipmentItem": [
      {
        "type": "ShipmentItem",
        "id": 123,
        "sku": "KDS2108",
        "product": {
          "type": "Product",
          "id": 123
        },
        "quantity": 4,
        "qty_shipped": 4,
        "qty_picked": 0,
        "qty_canceled": 0,
        "qty_cancel_requested": 0,
        "order_item": {
          "type": "OrderItem",
          "id": 123
        },
        "reservations": [
          {
            "location": {
              "type": "Location",
              "id": 42
            },
            "quantity": 123
          }
        ]
      }
    ],
    "ShipmentPackage": [
      {
        "items": [
          {
            "sku": "KDS2108",
            "quantity": 2,
            "order_item_id": 4,
            "order_item_sku": "KDS2108",
            "order_item_qty": 2,
            "shipment_item_id": 4,
            "weight": {
              "value": 20,
              "unit": "lb"
            },
            "hazmat_unit_weight": {
              "value": 20,
              "unit": "lb"
            },
            "total_customs_value": {
              "amount": 99,
              "currency": "USD"
            }
          }
        ],
        "packaging": [
          {
            "product": {
              "type": "Product",
              "id": 3
            },
            "quantity": 4
          }
        ],
        "collected_data": [
          {
            "order_item_id": 4,
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "ShipmentPackingSolution": [
      {
        "type": "ShipmentPackingSolution",
        "id": 3,
        "containers": [
          {
            "type": "ShipmentPackingSolutionContainer",
            "weight": {
              "value": 20,
              "unit": "lb"
            },
            "dimensions": {
              "length": 8,
              "width": 6,
              "height": 4,
              "unit": "in"
            },
            "volume": {
              "value": 300,
              "unit": "in^3"
            },
            "void_percent": 15.23,
            "regulation_type": "full",
            "items": [
              {
                "type": "ShipmentPackingSolutionContainerItem",
                "sku": "KDS2108",
                "quantity": 2,
                "order_item_id": 4,
                "order_item_sku": "KDS2108",
                "order_item_qty": 2,
                "shipment_item_id": 4,
                "weight": {
                  "value": 20,
                  "unit": "lb"
                }
              }
            ]
          }
        ]
      }
    ],
    "ThirdPartyBillingGroup": [
      {
        "type": "ThirdPartyBillingGroup",
        "id": 1,
        "label": "ACME Corp Billing",
        "status": "active"
      }
    ],
    "User": [
      {
        "type": "OrganizationUser",
        "id": 3
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ]
  },
  "has_more": true,
  "next": "<string>",
  "previous": "<string>",
  "meta": {
    "processing_time": 0.2525252525,
    "cursor_start": 123,
    "cursor_end": 123,
    "count": 123
  }
}

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Query Parameters

ā€‹
fields
enum<string>[]

Specify additional fields of the Order object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
carrier_code,
shipping_method,
signature_required,
is_saturday_delivery,
is_overbox_required,
other_shipping_options,
priority,
requested_ship_date,
is_declared_value_service,
declared_value,
shipping_address,
items,
shipments,
created_at,
updated_at,
completed_at,
status_history,
custom_greeting,
custom_fields,
weight,
total_item_count,
submitted_by,
submitted_by_type,
backorder_policy,
source,
customer_note,
batch_tag,
desired_delivery_date,
can_fulfill,
can_fulfill_at,
is_address_modified,
is_address_modified_auto,
hold_until_time,
tpb_group,
customs_value,
reason_for_export,
generate_sscc,
shipped_at,
delivered_at,
shipping_description,
carrier,
allocation_options,
automation_data,
original_address,
address_candidates,
instructions
ā€‹
fields:items
enum<string>[]

Specify additional fields of the OrderItem objects to be included in the response. See the selecting fields page for more information.

Available options:
all,
sku,
order_item_ref,
product,
qty_ordered,
qty_assigned,
qty_allocated,
qty_backordered,
qty_processing,
qty_picked,
qty_shipped,
qty_cancel_requested,
qty_canceled,
row_weight
ā€‹
fields:shipments
enum<string>[]

Specify additional fields of the Shipment objects to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
shipping_account,
shipping_method,
shipping_method_name,
target_ship_date,
total_weight,
shipped_weight,
items,
item_weight,
packages,
packing_solution,
picking_class_id,
is_cutoff_date_exception,
is_manually_processed,
label_print_target,
scac,
carrier_shipping_cost,
is_international,
is_documents_required,
is_electronic_customs,
infill_product_id,
max_package_weight,
packing_solution_providers,
tpb_group,
created_at,
updated_at,
packed_at
ā€‹
fields:shipments.warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response.

Available options:
all
ā€‹
fields:shipments.order
enum<string>[]

Specify additional fields of the Order object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
carrier_code,
shipping_method,
signature_required,
is_saturday_delivery,
is_overbox_required,
other_shipping_options,
priority,
requested_ship_date,
is_declared_value_service,
declared_value,
shipping_address,
items,
shipments,
created_at,
updated_at,
completed_at,
status_history,
custom_greeting,
custom_fields,
weight,
total_item_count,
submitted_by,
submitted_by_type,
backorder_policy,
source,
customer_note,
batch_tag,
desired_delivery_date,
can_fulfill,
can_fulfill_at,
is_address_modified,
is_address_modified_auto,
hold_until_time,
tpb_group,
customs_value,
reason_for_export,
generate_sscc,
shipped_at,
delivered_at,
shipping_description,
carrier,
allocation_options,
automation_data,
original_address,
address_candidates,
instructions
ā€‹
fields:shipments.items
enum<string>[]

Specify additional fields of the ShipmentItem objects to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
sku,
product,
quantity,
qty_shipped,
qty_picked,
qty_canceled,
qty_cancel_requested,
order_item,
reservations
ā€‹
fields:shipments.packages
enum<string>[]

Specify additional fields of the ShipmentPackage objects to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:
basic,
all,
created_at,
updated_at,
container_options,
supplies_options,
data_collection_options,
instruction_options,
infill_options,
vendor_sku,
external_id,
barcodes,
goods_type,
is_available,
is_visible,
weight,
dimensions,
volume,
inventory,
export,
regulated_goods,
packaging,
custom_fields
ā€‹
fields:shipments.packing_solution
enum<string>[]

Specify additional fields of the ShipmentPackingSolution object to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:
all,
created_at,
updated_at
ā€‹
fields:merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
status,
created_at,
updated_at,
brands,
default_brand
ā€‹
fields:merchant.brands
enum<string>[]

Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
is_active,
is_deleted,
sort_order
ā€‹
fields:merchant.default_brand
enum<string>[]

Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
is_active,
is_deleted,
sort_order
ā€‹
fields:brand
enum<string>[]

Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
is_active,
is_deleted,
sort_order
ā€‹
fields:shipping_address
enum<string>[]

Specify additional fields of the OrderAddress object (shipping address) to be included in the response. See the selecting fields page for more information.

Available options:
all,
first_name,,
last_name,,
company,,
street,,
city,,
region,,
postcode,,
country,,
telephone,,
email,,
classification,,
is_valid
ā€‹
fields:status_history
enum<string>[]

Specify additional fields of the OrderStatusHistory objects to be included in the response. See the selecting fields page for more information.

Available options:
all,
status,
comment,
notify_merchant,
user,
script_id,
created_at
ā€‹
fields:original_address
enum<string>[]

Specify additional fields of the OrderAddress object (original address) to be included in the response. See the selecting fields page for more information.

Available options:
all,
first_name,,
last_name,,
company,,
street,,
city,,
region,,
postcode,,
country,,
telephone,,
email,,
classification,,
is_valid
ā€‹
fields:address_candidates
enum<string>[]

Specify additional fields of the OrderAddressCandidate objects to be included in the response. See the selecting fields page for more information.

Available options:
all,
address_id,
street,
city,
region_code,
postal_code,
country_code,
classification
ā€‹
fields:instructions
enum<string>[]

Specify additional fields of the OrderInstruction objects to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
order_id,
note,
file_name,
presentation,
print_target,
print_orientation,
copies_printed
ā€‹
fields:tpb_group
enum<string>[]

Specify additional fields of the ThirdPartyBillingGroup object to be included in the response. See the selecting fields page for more information.

Available options:
all,
label,
status
ā€‹
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • unique_id
  • order_ref
  • state - Order lifecycle state (new, processing, complete, canceled, holded)
  • status - Order status (new, holded, processing, complete, canceled, invalid_address, unresolved, unable_to_process, delayed_shipment, partial_backorder, backordered)
  • merchant_id
  • merchant_code
  • source - Order source identifier set by APIs/plugins
  • batch_tag - Batch grouping tag
  • can_fulfill - Fulfillment readiness (true/false)
  • created_at
  • updated_at
  • completed_at
ā€‹
sort
string

The default sort order is descending by primary key (sort=-id). The following fields are available for sorting:

  • id
  • unique_id
  • created_at
  • updated_at
  • completed_at
  • merchant_id
ā€‹
count
integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1
ā€‹
cursor_end
integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

ā€‹
cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

ā€‹
limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

Response

A dictionary with a collection property that contains an array of up to limit Order objects. If no orders are found the array will be empty.

ā€‹
collection
Order Ā· object[]

A list of Order objects.

ā€‹
included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

ā€‹
has_more
boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

ā€‹
next
string | null

The resource path for the next page of results if any are expected.

ā€‹
previous
string | null

The resource path for the previous page of results if any are expected.

ā€‹
meta
object

Additional metadata pertaining to the response.