Create
Information about the orders to create
The Channel code
Commercial order's identifier
Customer information of the order
True if order is paid directly to seller. False otherwise.
Invoice information linked to the order
List of offers of the commercial order
Order additional fields
Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the order. Possible values:
- TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) are expressed without tax (taxes should be added to these prices in order to get the full amount including taxes).
- TAX_INCLUDED: the price fields include the tax amount.
The payment's duration (i.e. the delay after which the order is supposed to be paid), in days. Only applicable for PAY_ON_DUE_DATE orders, null otherwise. Note that this field has currently no impact on the order workflow, it is provided for information purposes.
Payment information
The payment workflow followed by the order. Possible values are: PAY_ON_ACCEPTANCE, PAY_ON_DELIVERY, PAY_ON_DUE_DATE, PAY_ON_SHIPMENT, NO_CUSTOMER_PAYMENT_CONFIRMATION
Promotions' summary applied to the order
Order references
Whether or not the customer is scored
Shipping zone code
{ "channelCode": "Example String", "commercialId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "customer": { "__typename": "OrdersCustomerInput" }, "customerDirectlyPaysSeller": true, "invoiceDetails": { "__typename": "OrderInvoiceInput" }, "offers": [ { "__typename": "OrderOfferInput" } ], "orderAdditionalFields": [ { "__typename": "AdditionalFieldValueInput" } ], "orderTaxMode": "Example String", "paymentDuration": 40, "paymentInfo": { "__typename": "OrderPaymentInfoInput" }, "paymentWorkflow": "Example String", "promotion": { "__typename": "OrderPromotionInput" }, "references": { "__typename": "OrderReferencesInput" }, "scored": true, "shippingZoneCode": "Example String" }
Orders
Customer information of the order
Customer's identifier
Data related to the accounting contact in the organization. Can be provided for platforms supporting B2B models.
Customer's billing address
Customer's Civility
Data related to the delivery contact in the organization. Can be provided for platforms supporting B2B models.
Customer's email
Customer's firstname
Customer's lastname
Customer's locale
Data related to the organization that created the order (B2B transactions). Mandatory if corresponding platform setting requires it. Can update organization data if an organization already exists with the “organization_id” provided and other fields are filled in. Otherwise creates a new organization.
Customer's shipping address
{ "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "accountingContact": { "__typename": "OrderCustomerAccountingContactInput" }, "billingAddress": { "__typename": "OrderCustomerBillingAddressInput" }, "civility": "Example String", "deliveryContact": { "__typename": "OrderCustomerDeliveryContactInput" }, "email": "Example String", "firstname": "Example String", "lastname": "Example String", "locale": "Example Custom Scalar", "organization": { "__typename": "CustomerOrganizationInput" }, "shippingAddress": { "__typename": "OrderCustomerShippingAddressInput" } }
Order
Data related to the accounting contact in the organization. Can be provided for platforms supporting B2B models.
{ "civility": "Example String", "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "firstname": "Example String", "lastname": "Example String", "locale": "Example Custom Scalar" }
Order
Customer's billing address
Address City
Civility of the person associated with the address
Company of the person associated with the address
Second company information of the person associated with the address
Country ISO 3166-1 code of the address
First information line of the address
Last name of the person associated with the address
Phone of the person associated with the address
Secondary phone of the person associated with the address
Address state
First information line of the address
Second information line of the address
Address zip code, mandatory with some exceptions
{ "city": "Example String", "civility": "Example String", "company": "Example String", "company2": "Example String", "country": "Example Custom Scalar", "firstname": "Example String", "lastname": "Example String", "phone": "Example String", "phoneSecondary": "Example String", "state": "Example String", "street1": "Example String", "street2": "Example String", "zipCode": "Example String" }
Order
Data related to the delivery contact in the organization. Can be provided for platforms supporting B2B models.
{ "civility": "Example String", "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "firstname": "Example String", "lastname": "Example String", "locale": "Example Custom Scalar" }
Customer
Data related to the organization that created the order (B2B transactions). Mandatory if corresponding platform setting requires it. Can update organization data if an organization already exists with the “organization_id” provided and other fields are filled in. Otherwise creates a new organization.
Address of the organization. Required for new organizations.
Number used to identify the customer organization as an established business in a country. E.g: SIRET number in France, NIF in Spain. Required for new organizations.
Name of the organization. Required for new organizations.
Customer's organization id (from the operator's system)
Tax identification number of the organization.
{ "address": { "__typename": "CustomerOrganizationAddressInput" }, "identificationNumber": "Example String", "name": "Example String", "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "taxIdentificationNumber": "Example String" }
Order
Customer's shipping address
Additional information for the shipping address
Address City
Civility of the person associated with the address
Company of the person associated with the address
Second company information of the person associated with the address
Country ISO 3166-1 code of the address
First name of the person associated with the address
Internal additional information for the shipping address
Last name of the person associated with the address
Phone of the person associated with the address
Secondary phone of the person associated with the address
Address state
First information line of the address
Second information line of the address
Address zip code, mandatory with some exceptions
{ "additionalInfo": "Example String", "city": "Example String", "civility": "Example String", "company": "Example String", "company2": "Example String", "country": "Example Custom Scalar", "firstname": "Example String", "internal_additional_info": "Example String", "lastname": "Example String", "phone": "Example String", "phoneSecondary": "Example String", "state": "Example String", "street1": "Example String", "street2": "Example String", "zipCode": "Example String" }