CreateOrderInput
An order with final prices, as an external system such as a marketplace hands it over. Prices are taken over and never recalculated: no cart, promotions or price rules of the shop apply. The order totals are derived from the line items and the shipping costs. Exactly one of customerId and guestCustomer must be given.
**Note:** Every order created this way counts towards the order volume of the shop's Pickware plan, like an order placed in the storefront. Orders beyond the plan's included orders are charged the order fee.
input CreateOrderInput {
idempotencyKey: String!
salesChannelId: ID!
currencyId: ID!
taxStatus: OrderTaxStatus!
billingAddress: OrderAddressInput!
lineItems: [CreateOrderLineItemInput!]!
shippingMethodId: ID!
paymentMethodId: ID!
customerId: ID
guestCustomer: GuestCustomerInput
shippingAddress: OrderAddressInput
shippingCosts: OrderShippingCostsInput
paymentAmount: Float
orderNumber: String
orderDateTime: DateTime
externalOrderNumber: String
customerComment: String
}
Fields
CreateOrderInput.idempotencyKey ● String! non-null scalar
Key that identifies this order in the calling system, e.g. its marketplace order ID. Calling the mutation again with a key that already created an order returns that order instead of creating a second one, so a call that timed out can safely be repeated. At most 255 characters.
CreateOrderInput.salesChannelId ● ID! non-null scalar
ID of the sales channel the order belongs to. The order takes over its language.
CreateOrderInput.currencyId ● ID! non-null scalar
ID of the currency all prices of the order are given in.
CreateOrderInput.taxStatus ● OrderTaxStatus! non-null enum
Whether the given prices include tax.
CreateOrderInput.billingAddress ● OrderAddressInput! non-null input
Billing address of the order.
CreateOrderInput.lineItems ● [CreateOrderLineItemInput!]! non-null input
Line items of the order. Must not be empty.
CreateOrderInput.shippingMethodId ● ID! non-null scalar
ID of the shipping method of the order's delivery.
CreateOrderInput.paymentMethodId ● ID! non-null scalar
ID of the payment method of the order's payment.
CreateOrderInput.customerId ● ID scalar
ID of the existing customer who placed the order.
CreateOrderInput.guestCustomer ● GuestCustomerInput input
Buyer without a customer account. A guest customer is created for the order.
CreateOrderInput.shippingAddress ● OrderAddressInput input
Shipping address of the order. Defaults to the billing address.
CreateOrderInput.shippingCosts ● OrderShippingCostsInput input
Shipping costs of the order. Defaults to free shipping.
CreateOrderInput.paymentAmount ● Float scalar
Amount of the order's payment in the order's currency, e.g. when the order is paid in parts. Defaults to the order total.
CreateOrderInput.orderNumber ● String scalar
Order number. Generated from the shop's order number range when omitted.
CreateOrderInput.orderDateTime ● DateTime scalar
Time the order was placed. Defaults to now.
CreateOrderInput.externalOrderNumber ● String scalar
Order number in the external system, e.g. the marketplace order number. Stored in the custom field pickware_erp_starter_external_order_number, which the DATEV export and the Amazon integration read.
CreateOrderInput.customerComment ● String scalar
Comment the customer left on the order.
Member Of
importOrder mutation ● placeOrder mutation