Skip to main content

Queries & Mutations

In addition to the system objects, the Management API allows many other operations and advanced data manipulation of your shipping related data.

Shipments operations

Query shipments

query get_shipments($filter: ShipmentFilter) {
shipments(filter: $filter) {
page_info {
count
has_next_page
has_previous_page
start_cursor
end_cursor
}
edges {
node {
id
carrier_id
carrier_name
created_at
updated_at
created_by {
email
full_name
}
status
recipient {
id
postal_code
city
person_name
company_name
country_code
email
phone_number
state_code
suburb
residential
street_number
address_line1
address_line2
federal_tax_id
state_tax_id
validate_location
}
shipper {
id
postal_code
city
person_name
company_name
country_code
email
phone_number
state_code
suburb
residential
street_number
address_line1
address_line2
federal_tax_id
state_tax_id
validate_location
}
billing_address {
id
postal_code
city
person_name
company_name
country_code
email
phone_number
state_code
suburb
residential
street_number
address_line1
address_line2
federal_tax_id
state_tax_id
validate_location
}
parcels {
id
width
height
length
is_document
dimension_unit
weight
weight_unit
packaging_type
package_preset
freight_class
reference_number
items {
id
weight
title
description
quantity
sku
hs_code
value_amount
weight_unit
value_currency
origin_country
metadata
parent_id
}
}
label_type
tracking_number
shipment_identifier
label_url
invoice_url
tracking_url
tracker_id
test_mode
service
reference
customs {
id
certify
commercial_invoice
content_type
content_description
incoterm
invoice
invoice_date
signer
duty {
paid_by
currency
account_number
declared_value
}
options
commodities {
id
weight
weight_unit
title
description
quantity
sku
hs_code
value_amount
value_currency
origin_country
metadata
parent_id
}
duty_billing_address {
id
postal_code
city
person_name
company_name
country_code
email
phone_number
state_code
suburb
residential
street_number
address_line1
address_line2
federal_tax_id
state_tax_id
validate_location
}
}
payment {
paid_by
currency
account_number
}
selected_rate_id
selected_rate {
id
carrier_name
carrier_id
currency
service
transit_days
total_charge
extra_charges {
name
amount
currency
}
test_mode
meta
}
carrier_ids
rates {
id
carrier_name
carrier_id
currency
service
transit_days
total_charge
extra_charges {
name
amount
currency
}
test_mode
meta
}
options
metadata
meta
messages {
carrier_name
carrier_id
message
code
details
}
selected_rate_carrier {
carrier_id
carrier_name
config
}
}
}
}
}

Shipment partial update

mutation updateShipment($data: PartialShipmentMutationInput!) {
partial_shipment_update(input: $data) {
shipment {
id
status
recipient {
id
postal_code
city
person_name
company_name
country_code
email
phone_number
state_code
suburb
residential
street_number
address_line1
address_line2
federal_tax_id
state_tax_id
validate_location
}
shipper {
id
postal_code
city
person_name
company_name
country_code
email
phone_number
state_code
suburb
residential
street_number
address_line1
address_line2
federal_tax_id
state_tax_id
validate_location
}
billing_address {
id
postal_code
city
person_name
company_name
country_code
email
phone_number
state_code
suburb
residential
street_number
address_line1
address_line2
federal_tax_id
state_tax_id
validate_location
}
parcels {
id
width
height
length
is_document
dimension_unit
weight
weight_unit
packaging_type
package_preset
freight_class
reference_number
items {
id
weight
title
description
quantity
sku
hs_code
value_amount
weight_unit
value_currency
origin_country
metadata
parent_id
}
}
label_type
service
reference
customs {
id
certify
commercial_invoice
content_type
content_description
incoterm
invoice
invoice_date
signer
duty {
paid_by
currency
account_number
declared_value
}
options
commodities {
id
weight
weight_unit
title
description
quantity
sku
hs_code
value_amount
value_currency
origin_country
metadata
parent_id
}
duty_billing_address {
id
postal_code
city
person_name
company_name
country_code
email
phone_number
state_code
suburb
residential
street_number
address_line1
address_line2
federal_tax_id
state_tax_id
validate_location
}
}
payment {
paid_by
currency
account_number
}
carrier_ids
options
metadata
rates {
id
carrier_name
carrier_id
currency
service
transit_days
total_charge
extra_charges {
name
amount
currency
}
test_mode
meta
}
messages {
carrier_name
carrier_id
message
code
details
}
}
errors {
field
messages
}
}
}