OrderImportShippingInput
A shipping destination of an order to import, with the item quantities it dispatches and optional parcel details.
input OrderImportShippingInput {
address1: String!
address2: String
carrierServiceIdentifier: String!
city: String!
companyName: String
email: String
firstName: String
isoCountry: String!
lastName: String
lines: [OrderImportShippingOrderLineInput!]
number: String
parcels: [OrderImportParcelInput!]
province: String
telephone: String
warehouseCode: String
zipCode: String!
}
Fields
OrderImportShippingInput.address1 ● String! non-null scalar
The street address.
OrderImportShippingInput.address2 ● String scalar
A secondary address line.
OrderImportShippingInput.carrierServiceIdentifier ● String! non-null scalar
An identifier of the shipping method chosen for the shipping (we recommend including the shipping zone and the service or carrier type). OMS maps it to a specific carrier and service according to your channel configuration.
OrderImportShippingInput.city ● String! non-null scalar
The city.
OrderImportShippingInput.companyName ● String scalar
The company name of the recipient.
OrderImportShippingInput.email ● String scalar
The email address of the recipient.
OrderImportShippingInput.firstName ● String scalar
The first name of the recipient.
OrderImportShippingInput.isoCountry ● String! non-null scalar
The country, as an ISO 3166-1 alpha-2 code (for example IT).
OrderImportShippingInput.lastName ● String scalar
The last name of the recipient.
OrderImportShippingInput.lines ● [OrderImportShippingOrderLineInput!] list input
Splits the item quantities across shippings, referencing only item lines. Not needed for a single shipping dispatching the whole order, required when there is more than one shipping. Each lineNumber must match an item order line number, and the quantities of each line across all shippings must add up exactly to the ordered quantity.
OrderImportShippingInput.number ● String scalar
The number identifying the shipping within the order.
OrderImportShippingInput.parcels ● [OrderImportParcelInput!] list input
Optional parcel details of the shipping.
OrderImportShippingInput.province ● String scalar
The province.
OrderImportShippingInput.telephone ● String scalar
The shipping telephone number.
OrderImportShippingInput.warehouseCode ● String scalar
The code of the warehouse the shipping is dispatched from. Required on channels with more than one warehouse, and it must belong to the channel; it can be omitted on a single-warehouse channel.
OrderImportShippingInput.zipCode ● String! non-null scalar
The postal code.
Member Of
OrderImportInput input