GraphQL API
Organization API
Organization / Types/ object

Shipment

A shipment of a company

Fields

31 fields
barcodeString

Barcode of the shipment

urlString!

Url of the avatar

A list of BrandPortal edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of CommunicationTemplate edges.

pageInfoPageInfo!

Pagination information about the list of edges.

createdAtDateTimeTz!

When the brand was created.

customsShipmentTypeCustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmptyBoolean!

Use reference if invoice number is empty

idID!

Unique primary key.

inboundGBEoriString

Import EORI for GB

inboundGBVatString

Import VAT number for GB

urlString!

Url of the avatar

urlString!

Url of the avatar

nameString!

Name of the brand

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

updatedAtDateTimeTz!

When the brand was last updated.

canceledAtDateTime

When the shipment was canceled.

codeString!

Code of the carrier

logoUrlString

Logo URL

nameString!

Name

trackingUrlString

Regular tracking URL

cursorString!

A unique cursor that can be used for pagination.

The ShipmentContent node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

createdAtDateTimeTz!

When the shipment was created.

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

createdAtDateTimeTz!

When the customer was created.

idID!

Unique primary key.

A list of Order edges.

pageInfoPageInfo!

Pagination information about the list of edges.

ordersCountInt!

Customer orders count

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

referenceString

Reference of the customer

A list of ReturnRequest edges.

pageInfoPageInfo!

Pagination information about the list of edges.

returnRequestsCountInt!

Customer return requests count

A list of Shipment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

shipmentsCountInt!

Customer shipments count

updatedAtDateTimeTz!

When the customer was last updated.

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

cursorString!

A unique cursor that can be used for pagination.

nodeEvent!

The Event node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

cursorString!

A unique cursor that can be used for pagination.

The ShipmentFile node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

idID!

Unique primary key.

currencyString!

ISO 4217 currency code

valueString!

Amount

labelTypeString

Requested label type of the shipment

cursorString!

A unique cursor that can be used for pagination.

The ShipmentPiece node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

piecesCountInt

Number of pieces

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

referenceString

Reference of the shipment

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

codeString!

Phase code

createdAtDateTimeTz!

When the phase was created

descriptionString

Phase description

nameString!

Phase name

updatedAtDateTimeTz!

When the phase was last updated

codeString!

Code of the carrier

logoUrlString

Logo URL

nameString!

Name

trackingUrlString

Regular tracking URL

createdAtDateTimeTz!

When the shipping service was created.

defaultLabelTypeShipmentFileType!

Default label type

PDFZPL_200ZPL_300
idID!

Unique primary key.

Category of the integration

invoicingpaymentshippingshop
createdAtDateTimeTz!

When the integration was created.

idID!

Unique primary key.

isEnabledBoolean!

Synchronization enabled

isOrderSyncEnabledBoolean!

Order sync enabled

isProductSyncEnabledBoolean!

Product sync enabled

isStockSyncEnabledBoolean!

Stock sync enabled

nameString!

Name of the integration

orderSyncUpdatedAtDateTimeTz

When the last order was updated at the integration while syncing

Payment profiles exposed by the integration

productSyncUpdatedAtDateTimeTz

When the last product was updated at the integration while syncing

productsCountInt!

Number of products linked to this integration.

updatedAtDateTimeTz!

When the integration was last updated.

isEnabledBoolean!

Enabled

labelTypes[ShipmentFileType!]

Type of shipment files

PDFZPL_200ZPL_300

A list of ShippingServiceMethod edges.

pageInfoPageInfo!

Pagination information about the list of edges.

nameString!

Name of the shipping service

typeString!

Type of shipping service

updatedAtDateTimeTz!

When the shipping service was last updated.

codeString!

Code of the carrier

logoUrlString

Logo URL

nameString!

Name

trackingUrlString

Regular tracking URL

A list of ShippingServiceMethodCountry edges.

pageInfoPageInfo!

Pagination information about the list of edges.

createdAtDateTimeTz!

When the shipping service was created.

idID!

Unique primary key.

isCancelableBoolean!

Whether or not shipment (labels) are cancelable

isEnabledBoolean!

Enabled

nameString!

Name of the shipping service method

carrierCarrier!

Carrier that is linked to the shipping service

createdAtDateTimeTz!

When the shipping service was created.

defaultLabelTypeShipmentFileType!

Default label type

PDFZPL_200ZPL_300
idID!

Unique primary key.

integrationIntegration

Integration that provided this shipping service

isEnabledBoolean!

Enabled

labelTypes[ShipmentFileType!]

Type of shipment files

PDFZPL_200ZPL_300

The methods associated with this shipping service.

nameString!

Name of the shipping service

typeString!

Type of shipping service

updatedAtDateTimeTz!

When the shipping service was last updated.

typeString!

Type type

updatedAtDateTimeTz!

When the shipping service was last updated.

codeString!

Status code

createdAtDateTimeTz!

When the status was created

descriptionString

Status description

nameString!

Status name

codeString!

Phase code

createdAtDateTimeTz!

When the phase was created

descriptionString

Phase description

nameString!

Phase name

updatedAtDateTimeTz!

When the phase was last updated

updatedAtDateTimeTz!

When the status was last updated

Status of the shipment

CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPED
cursorString!

A unique cursor that can be used for pagination.

The SupportTicketAccess node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

trackingCodeString

Tracking code of the shipment

trackingUrlString

Tracking url of the shipment

typeString!

Type of the shipment

updatedAtDateTimeTz!

When the shipment was last updated.