GraphQL API
Organization API
Organization / Shipments

shipmentCreate

Create a new shipment

Arguments

1 argument
brandIdID

Brand ID

countryCodeOfOriginString

Country code of origin

descriptionString

Description

hsCodeString

Harmonized System code

priceMoneyInput

Price per unit

quantityInt

Quantity

weightWeightInput

Weight per unit

customerIdID

Customer ID

customsInvoiceNumberString

Customs invoice number

customsShipmentTypeCustomsShipmentType

Customs shipment type

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
currencyString!

ISO 4217 currency code

valueString!

Amount

labelTypeString

Label type

piecesCountInt

Number of pieces

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name (required when no name provided)

countryCodeString

ISO code 3166 alpha 2

emailString

Email address

eoriString

Economic Operators Registration and Identification number

houseNumberString

House number and addition

nameString

Contact person name (required when no company name provided)

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT identification number

referenceString

Reference number

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name (required when no name provided)

countryCodeString

ISO code 3166 alpha 2

emailString

Email address

eoriString

Economic Operators Registration and Identification number

houseNumberString

House number and addition

nameString

Contact person name (required when no company name provided)

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT identification number

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name (required when no name provided)

countryCodeString

ISO code 3166 alpha 2

emailString

Email address

eoriString

Economic Operators Registration and Identification number

houseNumberString

House number and addition

nameString

Contact person name (required when no company name provided)

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT identification number

shippingPreferencesMixed

Shipping preferences

shippingServiceMethodIdID

Shipping service method ID

statusString

Status

Possible return

barcodeString

Barcode of the shipment

canceledAtDateTime

When the shipment was canceled.

createdAtDateTimeTz!

When the shipment was created.

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
idID!

Unique primary key.

labelTypeString

Requested label type of the shipment

piecesCountInt

Number of pieces

referenceString

Reference of the shipment

Status of the shipment

CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPED
trackingCodeString

Tracking code of the shipment

trackingUrlString

Tracking url of the shipment

typeString!

Type of the shipment

updatedAtDateTimeTz!

When the shipment was last updated.

field[String!]
messageString!