List all Shipments
Returns a list of Shipment objects.
Authorizations
Query Parameters
Specify additional fields of the Shipment object to be included in the response.
See the selecting fields page for more information.
basic, all, shipping_account, shipping_method, shipping_method_name, target_ship_date, total_weight, shipped_weight, items, item_weight, packages, packing_solution, gallery, 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, retailer, retailer_ship_to_location, mark_for_location Specify additional fields of the ShipmentItem object to be included in the response. See the selecting fields page for more information.
basic, all, sku, product, quantity, qty_shipped, qty_picked, qty_canceled, qty_cancel_requested, order_item, reservations Specify additional fields of the Product 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.
basic, all, created_at, updated_at, container_options, supplies_options, data_collection_options, instruction_options, infill_options, vendor_sku, manufacturer_part_number, unit_level, external_id, barcodes, goods_type, is_available, is_visible, weight, dimensions, volume, inventory, export, regulated_goods, packaging, custom_fields Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.
all, order_item_ref, qty_ordered, qty_assigned, qty_allocated, qty_backordered, qty_processing, qty_picked, qty_shipped, qty_cancel_requested, qty_canceled, row_weight Specify additional fields of the Order object to be included in the response. See the selecting fields page for more information.
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, duties_payor, 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, retailer, retailer_ship_to_location, mark_for_location Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.
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 Specify additional fields of the Shipment object to be included in the response. See the selecting fields page for more information.
basic, all, shipping_account, shipping_method, shipping_method_name, target_ship_date, total_weight, shipped_weight, items, item_weight, packages, packing_solution, gallery, 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, retailer, retailer_ship_to_location, mark_for_location Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.
basic, all, code, name, status, created_at, updated_at, brands, default_brand, custom_fields Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.
basic, all, code, name, is_active, is_deleted, sort_order Specify additional fields of the OrderAddress object to be included in the response. See the selecting fields page for more information.
all, first_name,, last_name,, company,, street,, city,, region,, postcode,, country,, telephone,, email,, classification,, is_valid Specify additional fields of the OrderStatusHistory object to be included in the response. See the selecting fields page for more information.
all, status, comment, notify_merchant, user, script_id, created_at Specify additional fields of the OrderAddress object (original address) to be included in the response. See the selecting fields page for more information.
all, first_name,, last_name,, company,, street,, city,, region,, postcode,, country,, telephone,, email,, classification,, is_valid Specify additional fields of the OrderAddressCandidate objects to be included in the response. See the selecting fields page for more information.
all, address_id, street, city, region_code, postal_code, country_code, classification Specify additional fields of the OrderInstruction objects to be included in the response. See the selecting fields page for more information.
basic, all, order_id, note, identifier, kind, kind_label, shipment_id, is_shipment, confirmation_generation, carrier_delivered_at, upload_retired_at, file_name, presentation, print_target, print_orientation, copies_printed Specify additional fields of the ThirdPartyBillingGroup object (via the order relationship) to be included in the response. See the selecting fields page for more information.
all, label, status Specify additional fields of the ShipmentPackage object to be included in the response.
basic, all, tracking_ref, alt_tracking_number, alt_tracking_description, billable_weight, dimensional_weight, dimensional_weight_divisor, total_item_volume, total_void_percent, container_style, num_cartons, sscc, manifest_courier_code, items, container, infill, packaging, collected_data, gallery, created_at, updated_at 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.
all, created_at, updated_at Specify additional fields of the Retailer object to be included in the response. See the selecting fields page for more information.
basic, all, code, name, status, fulfillment_model, parent_retailer, legal_name, dba, default_duties_payor, default_shipping_method, allowed_shipping_methods, routing_guide_notes, custom_fields, created_at, updated_at Specify additional fields of the RetailerShipToLocation object to be included in the response. See the selecting fields page for more information.
basic, all, code, qualifier, label, location_type, company, street, city, region_id, region, postcode, country_id, telephone, email, is_default, status, retailer, created_at, updated_at Specify additional fields of the mark-for RetailerShipToLocation object to be included in the response. See the selecting fields page for more information.
basic, all, code, qualifier, label, location_type, company, street, city, region_id, region, postcode, country_id, telephone, email, is_default, status, retailer, created_at, updated_at Specify additional fields of the nested parent Retailer of the parent Retailer. See the selecting fields page for more information.
basic, all, code, name, status, fulfillment_model, parent_retailer, legal_name, dba, default_duties_payor, default_shipping_method, allowed_shipping_methods, routing_guide_notes, custom_fields, created_at, updated_at Specify additional fields of the nested Retailer of the parent RetailerShipToLocation. See the selecting fields page for more information.
basic, all, code, name, status, fulfillment_model, parent_retailer, legal_name, dba, default_duties_payor, default_shipping_method, allowed_shipping_methods, routing_guide_notes, custom_fields, created_at, updated_at Specify additional fields of the nested Retailer of the parent mark-for RetailerShipToLocation. See the selecting fields page for more information.
basic, all, code, name, status, fulfillment_model, parent_retailer, legal_name, dba, default_duties_payor, default_shipping_method, allowed_shipping_methods, routing_guide_notes, custom_fields, created_at, updated_at Specify additional fields of the nested Retailer of the parent Order. See the selecting fields page for more information.
basic, all, code, name, status, fulfillment_model, parent_retailer, legal_name, dba, default_duties_payor, default_shipping_method, allowed_shipping_methods, routing_guide_notes, custom_fields, created_at, updated_at Specify additional fields of the nested RetailerShipToLocation of the parent Order. See the selecting fields page for more information.
basic, all, code, qualifier, label, location_type, company, street, city, region_id, region, postcode, country_id, telephone, email, is_default, status, retailer, created_at, updated_at Specify additional fields of the nested mark-for RetailerShipToLocation of the parent Order. See the selecting fields page for more information.
basic, all, code, qualifier, label, location_type, company, street, city, region_id, region, postcode, country_id, telephone, email, is_default, status, retailer, created_at, updated_at Using the filtering syntax, you may filter the results using the following fields:
idunique_idcreated_atupdated_atpacked_attracking_numberalt_tracking_numberretailer_id
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.
0 <= x <= 1A cursor for use in pagination which defines the end of the next page of results, non-inclusive.
For collections sorted by id this is the last id. For other sort orders use the
opaque cursor provided by the previous link and meta.cursor_end of the previous page;
a plain record id is also accepted and resolves to that record's position in the sort order.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the start of the next page of results.
For collections sorted by id this is the starting id. For other sort orders use the
opaque cursor provided by the next link and meta.cursor_start of the previous page;
a plain record id is also accepted and resolves to that record's position in the sort order.
See paging parameters for more information on paging.
Response
A dictionary with a collection property that contains an array of up to
limit Shipment objects. If no shipments are found the array will be empty.
Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.