GraphQL API
Organization API
Organization / Types/ object

Shipment

A shipment of a company

Fields

31 fields
barcode•String

Barcode of the shipment

url•String!

Url of the avatar

A list of BrandPortal edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of CommunicationTemplate edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

createdAt•DateTimeTz!

When the brand was created.

customsShipmentType•CustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmpty•Boolean!

Use reference if invoice number is empty

id•ID!

Unique primary key.

inboundGBEori•String

Import EORI for GB

inboundGBVat•String

Import VAT number for GB

url•String!

Url of the avatar

url•String!

Url of the avatar

name•String!

Name of the brand

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

updatedAt•DateTimeTz!

When the brand was last updated.

canceledAt•DateTime

When the shipment was canceled.

code•String!

Code of the carrier

logoUrl•String

Logo URL

name•String!

Name

trackingUrl•String

Regular tracking URL

cursor•String!

A unique cursor that can be used for pagination.

The ShipmentContent node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

createdAt•DateTimeTz!

When the shipment was created.

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

createdAt•DateTimeTz!

When the customer was created.

id•ID!

Unique primary key.

A list of Order edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

ordersCount•Int!

Customer orders count

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

reference•String

Reference of the customer

A list of ReturnRequest edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

returnRequestsCount•Int!

Customer return requests count

A list of Shipment edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

shipmentsCount•Int!

Customer shipments count

updatedAt•DateTimeTz!

When the customer was last updated.

customsInvoiceNumber•String

Invoice number for customs

customsShipmentType•CustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

cursor•String!

A unique cursor that can be used for pagination.

node•Event!

The Event node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

The ShipmentFile node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

id•ID!

Unique primary key.

currency•String!

ISO 4217 currency code

value•String!

Amount

labelType•String

Requested label type of the shipment

cursor•String!

A unique cursor that can be used for pagination.

The ShipmentPiece node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

piecesCount•Int

Number of pieces

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

reference•String

Reference of the shipment

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

code•String!

Phase code

createdAt•DateTimeTz!

When the phase was created

description•String

Phase description

name•String!

Phase name

updatedAt•DateTimeTz!

When the phase was last updated

code•String!

Code of the carrier

logoUrl•String

Logo URL

name•String!

Name

trackingUrl•String

Regular tracking URL

createdAt•DateTimeTz!

When the shipping service was created.

defaultLabelType•ShipmentFileType!

Default label type

PDFZPL_200ZPL_300
id•ID!

Unique primary key.

Category of the integration

invoicingpaymentshippingshop
createdAt•DateTimeTz!

When the integration was created.

id•ID!

Unique primary key.

isEnabled•Boolean!

Synchronization enabled

isOrderSyncEnabled•Boolean!

Order sync enabled

isProductSyncEnabled•Boolean!

Product sync enabled

isStockSyncEnabled•Boolean!

Stock sync enabled

name•String!

Name of the integration

orderSyncUpdatedAt•DateTimeTz

When the last order was updated at the integration while syncing

Payment profiles exposed by the integration

productSyncUpdatedAt•DateTimeTz

When the last product was updated at the integration while syncing

productsCount•Int!

Number of products linked to this integration.

updatedAt•DateTimeTz!

When the integration was last updated.

isEnabled•Boolean!

Enabled

labelTypes•[ShipmentFileType!]

Type of shipment files

PDFZPL_200ZPL_300

A list of ShippingServiceMethod edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

name•String!

Name of the shipping service

type•String!

Type of shipping service

updatedAt•DateTimeTz!

When the shipping service was last updated.

code•String!

Code of the carrier

logoUrl•String

Logo URL

name•String!

Name

trackingUrl•String

Regular tracking URL

A list of ShippingServiceMethodCountry edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

createdAt•DateTimeTz!

When the shipping service was created.

id•ID!

Unique primary key.

isCancelable•Boolean!

Whether or not shipment (labels) are cancelable

isEnabled•Boolean!

Enabled

name•String!

Name of the shipping service method

carrier•Carrier!

Carrier that is linked to the shipping service

createdAt•DateTimeTz!

When the shipping service was created.

defaultLabelType•ShipmentFileType!

Default label type

PDFZPL_200ZPL_300
id•ID!

Unique primary key.

integration•Integration

Integration that provided this shipping service

isEnabled•Boolean!

Enabled

labelTypes•[ShipmentFileType!]

Type of shipment files

PDFZPL_200ZPL_300

The methods associated with this shipping service.

name•String!

Name of the shipping service

type•String!

Type of shipping service

updatedAt•DateTimeTz!

When the shipping service was last updated.

type•String!

Type type

updatedAt•DateTimeTz!

When the shipping service was last updated.

code•String!

Status code

createdAt•DateTimeTz!

When the status was created

description•String

Status description

name•String!

Status name

code•String!

Phase code

createdAt•DateTimeTz!

When the phase was created

description•String

Phase description

name•String!

Phase name

updatedAt•DateTimeTz!

When the phase was last updated

updatedAt•DateTimeTz!

When the status was last updated

Status of the shipment

CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPED
cursor•String!

A unique cursor that can be used for pagination.

The SupportTicketAccess node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

trackingCode•String

Tracking code of the shipment

trackingUrl•String

Tracking url of the shipment

type•String!

Type of the shipment

updatedAt•DateTimeTz!

When the shipment was last updated.