GraphQL API
Organization API
Organization / Types/ object

Shipment

A shipment of a company

Fields

30 fields
idID!

Unique primary key.

barcodeString

Barcode of the shipment

trackingCodeString

Tracking code of the shipment

trackingUrlString

Tracking url of the shipment

labelTypeString

Requested label type of the shipment

piecesCountInt

Number of pieces

referenceString

Reference of the shipment

currencyString!

ISO 4217 currency code

valueString!

Amount

Status of the shipment

CANCELEDCREATEDERRORGENERATINGGENERATEDPRINTEDREQUESTEDSHIPPED
typeString!

Type of the shipment

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
createdAtDateTimeTz!

When the shipment was created.

updatedAtDateTimeTz!

When the shipment was last updated.

canceledAtDateTime

When the shipment was canceled.

idID!

Unique primary key.

nameString!

Name of the brand

customsShipmentTypeCustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmptyBoolean!

Use reference if invoice number is empty

inboundGBEoriString

Import EORI for GB

inboundGBVatString

Import VAT number for GB

createdAtDateTimeTz!

When the brand was created.

updatedAtDateTimeTz!

When the brand was last updated.

urlString!

Url of the avatar

urlString!

Url of the avatar

urlString!

Url of the avatar

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

pageInfoPageInfo!

Pagination information about the list of edges.

A list of BrandPortal edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of CommunicationTemplate edges.

idID!

Unique primary key.

referenceString

Reference of the customer

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

createdAtDateTimeTz!

When the customer was created.

updatedAtDateTimeTz!

When the customer was last updated.

ordersCountInt!

Customer orders count

returnRequestsCountInt!

Customer return requests count

shipmentsCountInt!

Customer shipments count

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Order edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ReturnRequest edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Shipment edges.

codeString!

Code of the carrier

nameString!

Name

logoUrlString

Logo URL

trackingUrlString

Regular tracking URL

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

codeString!

Phase code

nameString!

Phase name

descriptionString

Phase description

createdAtDateTimeTz!

When the phase was created

updatedAtDateTimeTz!

When the phase was last updated

idID!

Unique primary key.

nameString!

Name of the shipping service

defaultLabelTypeShipmentFileType!

Default label type

PDFZPL_200ZPL_300
isEnabledBoolean!

Enabled

labelTypes[ShipmentFileType!]

Type of shipment files

PDFZPL_200ZPL_300
typeString!

Type of shipping service

createdAtDateTimeTz!

When the shipping service was created.

updatedAtDateTimeTz!

When the shipping service was last updated.

codeString!

Code of the carrier

nameString!

Name

logoUrlString

Logo URL

trackingUrlString

Regular tracking URL

idID!

Unique primary key.

isEnabledBoolean!

Synchronization enabled

Category of the integration

invoicingpaymentshopshipping
nameString!

Name of the integration

isOrderSyncEnabledBoolean!

Order sync enabled

orderSyncUpdatedAtDateTimeTz

When the last order was updated at the integration while syncing

isProductSyncEnabledBoolean!

Product sync enabled

productSyncUpdatedAtDateTimeTz

When the last product was updated at the integration while syncing

isStockSyncEnabledBoolean!

Stock sync enabled

Payment profiles exposed by the integration

createdAtDateTimeTz!

When the integration was created.

updatedAtDateTimeTz!

When the integration was last updated.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ShippingServiceMethod edges.

idID!

Unique primary key.

nameString!

Name of the shipping service method

isCancelableBoolean!

Whether or not shipment (labels) are cancelable

isEnabledBoolean!

Enabled

typeString!

Type type

createdAtDateTimeTz!

When the shipping service was created.

updatedAtDateTimeTz!

When the shipping service was last updated.

idID!

Unique primary key.

nameString!

Name of the shipping service

defaultLabelTypeShipmentFileType!

Default label type

PDFZPL_200ZPL_300
isEnabledBoolean!

Enabled

labelTypes[ShipmentFileType!]

Type of shipment files

PDFZPL_200ZPL_300
typeString!

Type of shipping service

createdAtDateTimeTz!

When the shipping service was created.

updatedAtDateTimeTz!

When the shipping service was last updated.

carrierCarrier!

Carrier that is linked to the shipping service

integrationIntegration

Integration that provided this shipping service

The methods associated with this shipping service.

codeString!

Code of the carrier

nameString!

Name

logoUrlString

Logo URL

trackingUrlString

Regular tracking URL

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ShippingServiceMethodCountry edges.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

nodeEvent!

The Event node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

The ShipmentContent node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

The ShipmentFile node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

The ShipmentPiece node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

The SupportTicketAccess node.

cursorString!

A unique cursor that can be used for pagination.