GraphQL API
Organization API
Organization / Types/ input

ShipmentCreateInput

Input for creating a shipment

Input fields

15 fields
brandIdID

Brand ID

customerIdID

Customer ID

shippingServiceMethodIdID

Shipping service method ID

labelTypeString

Label type

piecesCountInt

Number of pieces

referenceString

Reference number

currencyString!

ISO 4217 currency code

valueString!

Amount

statusString

Status

customsInvoiceNumberString

Customs invoice number

customsShipmentTypeCustomsShipmentType

Customs shipment type

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
companyNameString

Company name (required when no name provided)

nameString

Contact person name (required when no company name provided)

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number and addition

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString

ISO code 3166 alpha 2

emailString

Email address

phoneString

Phone number

eoriString

Economic Operators Registration and Identification number

ossString

One-Stop Shop (OSS) number

vatString

VAT identification number

companyNameString

Company name (required when no name provided)

nameString

Contact person name (required when no company name provided)

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number and addition

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString

ISO code 3166 alpha 2

emailString

Email address

phoneString

Phone number

eoriString

Economic Operators Registration and Identification number

ossString

One-Stop Shop (OSS) number

vatString

VAT identification number

companyNameString

Company name (required when no name provided)

nameString

Contact person name (required when no company name provided)

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number and addition

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString

ISO code 3166 alpha 2

emailString

Email address

phoneString

Phone number

eoriString

Economic Operators Registration and Identification number

ossString

One-Stop Shop (OSS) number

vatString

VAT identification number

quantityInt

Quantity

descriptionString

Description

currencyString!

ISO 4217 currency code

valueString!

Amount

valueFloat

Weight value

unitWeightUnit

Unit of weight

GKGOZLBS
countryCodeOfOriginString

Country code of origin

hsCodeString

Harmonized System code

shippingPreferencesMixed

Shipping preferences