GraphQL API
Organization API
Organization / Types/ input

ShipmentCreateInput

Input for creating a shipment

Input fields

15 fields
brandId•ID

Brand ID

countryCodeOfOrigin•String

Country code of origin

description•String

Description

hsCode•String

Harmonized System code

currency•String!

ISO 4217 currency code

value•String!

Amount

quantity•Int

Quantity

unit•WeightUnit

Unit of weight

GKGLBSOZ
value•Float

Weight value

customerId•ID

Customer ID

customsInvoiceNumber•String

Customs invoice number

customsShipmentType•CustomsShipmentType

Customs shipment type

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
currency•String!

ISO 4217 currency code

value•String!

Amount

labelType•String

Label type

piecesCount•Int

Number of pieces

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name (required when no name provided)

countryCode•String

ISO code 3166 alpha 2

email•String

Email address

eori•String

Economic Operators Registration and Identification number

houseNumber•String

House number and addition

name•String

Contact person name (required when no company name provided)

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT identification number

reference•String

Reference number

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name (required when no name provided)

countryCode•String

ISO code 3166 alpha 2

email•String

Email address

eori•String

Economic Operators Registration and Identification number

houseNumber•String

House number and addition

name•String

Contact person name (required when no company name provided)

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT identification number

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name (required when no name provided)

countryCode•String

ISO code 3166 alpha 2

email•String

Email address

eori•String

Economic Operators Registration and Identification number

houseNumber•String

House number and addition

name•String

Contact person name (required when no company name provided)

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT identification number

shippingPreferences•Mixed

Shipping preferences

shippingServiceMethodId•ID

Shipping service method ID

status•String

Status