POST orders/create-orders
This allows you to import orders in bulk. You can only import a maximum of 5 orders at once.
Request Information
URI Parameters
None.
Body Parameters
This is a collection of Orders to import.
Collection of CreateOrderModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| ChannelId | This is the Channel that the order was placed on. | integer | Required |
| ChannelOrderRef | This is the order reference that was supplied by the Channel. | string | Required |
| OrderTotals | This is the Order Total | OrderTotalsModel | None. |
| CustomerReference | This is the customer reference for the order. | string | None. |
| CustomerEmail | This is the customer email. | string | None. |
| BillingAddress | This is the billing address for the order. | AddressModel | Required |
| ShippingAddress | This is the shipping address for the order. | AddressModel | Required |
| ShippingTotal | This is the total shipping cost. | decimal number | None. |
| OrderDate | This is the date that the order was placed. This is returned in UTC time. | date | None. |
| PaymentMethod | This is the Payment Method that was used to pay for the order. | string | None. |
| PaymentID | This is the Payment ID that was assigned to the order. | string | None. |
| ChannelShippingMethod | This is the shipping method information that the order Channel provided to StoreFeeder. | string | None. |
| SpecialInstructions | This is a list of any special instructions that were stored against the order. | string | None. |
| CurrencyCode | This is the 3-character currency code of the order, e.g. GBP, USD | string | None. |
| ExchangeRate | This is the exchange rate of the order currency to the default currency on the account at the time the order was imported into StoreFeeder. | decimal number | None. |
| IossNumber | This is the IOSS number (Import One-Stop Shop) for seamless cross-border transactions, So that customers can enjoy a smooth purchasing experience and comply with VAT regulations. | string | None. |
| OrderLines | This is a list of the details of each individual line in the order. | Collection of CreateOrderLineModel | Required |
| ShipByDate | The date that this order should be shipped by | date | None. |
| SetAsOnHold | Whether or not this order (and every order split from it) should be created with an Order Status of On Hold | boolean | None. |
Request Formats
application/json, text/json
Sample:
[
{
"ChannelId": 123456,
"ChannelOrderRef": "ORD200001",
"CustomerReference": "0001",
"BillingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"ShippingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"ShippingTotal": 0.0,
"PaymentMethod": "PayPal",
"PaymentID": "PAYREF0001",
"ChannelShippingMethod": "Channel Shipping Method 1",
"SpecialInstructions": "Do not bend",
"CurrencyCode": "GBP",
"OrderLines": [
{
"OrderedProductSKU": "PRODUCTSKU",
"OrderedProductName": "Product Name",
"QuantityOrdered": 1,
"SingleItemPrice": 1.0,
"TotalItemPriceExVat": 1.0,
"TotalItemPriceIncVat": 1.2,
"VatTotal": 0.2,
"TaxRate": 20.0,
"ItemOptions": "Engraved with customer's name"
}
]
},
{
"ChannelId": 1234,
"ChannelOrderRef": "ORD200002",
"CustomerReference": "0001",
"BillingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"ShippingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"ShippingTotal": 0.0,
"PaymentMethod": "PayPal",
"PaymentID": "PAYREF0001",
"ChannelShippingMethod": "Channel Shipping Method 1",
"SpecialInstructions": "Do not bend",
"CurrencyCode": "GBP",
"OrderLines": [
{
"OrderedProductSKU": "PRODUCTSKU",
"OrderedProductName": "Product Name",
"QuantityOrdered": 1,
"SingleItemPrice": 1.0,
"TotalItemPriceExVat": 1.0,
"TotalItemPriceIncVat": 1.2,
"VatTotal": 0.2,
"TaxRate": 20.0,
"ItemOptions": "Engraved with customer's name"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfCreateOrderModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CreateOrderModel>
<ChannelId>123456</ChannelId>
<ChannelOrderRef>ORD200001</ChannelOrderRef>
<CustomerReference>0001</CustomerReference>
<BillingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</BillingAddress>
<ShippingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</ShippingAddress>
<ShippingTotal>0</ShippingTotal>
<OrderDate xsi:nil="true" />
<PaymentMethod>PayPal</PaymentMethod>
<PaymentID>PAYREF0001</PaymentID>
<ChannelShippingMethod>Channel Shipping Method 1</ChannelShippingMethod>
<SpecialInstructions>Do not bend</SpecialInstructions>
<CurrencyCode>GBP</CurrencyCode>
<ExchangeRate xsi:nil="true" />
<OrderLines>
<CreateOrderLineModel>
<OrderedProductSKU>PRODUCTSKU</OrderedProductSKU>
<OrderedProductName>Product Name</OrderedProductName>
<QuantityOrdered>1</QuantityOrdered>
<SingleItemPrice>1</SingleItemPrice>
<TotalItemPriceExVat>1</TotalItemPriceExVat>
<TotalItemPriceIncVat>1.2</TotalItemPriceIncVat>
<VatTotal>0.2</VatTotal>
<TaxRate>20</TaxRate>
<Discount xsi:nil="true" />
<ItemOptions>Engraved with customer's name</ItemOptions>
</CreateOrderLineModel>
</OrderLines>
<ShipByDate xsi:nil="true" />
<SetAsOnHold xsi:nil="true" />
</CreateOrderModel>
<CreateOrderModel>
<ChannelId>1234</ChannelId>
<ChannelOrderRef>ORD200002</ChannelOrderRef>
<CustomerReference>0001</CustomerReference>
<BillingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</BillingAddress>
<ShippingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</ShippingAddress>
<ShippingTotal>0</ShippingTotal>
<OrderDate xsi:nil="true" />
<PaymentMethod>PayPal</PaymentMethod>
<PaymentID>PAYREF0001</PaymentID>
<ChannelShippingMethod>Channel Shipping Method 1</ChannelShippingMethod>
<SpecialInstructions>Do not bend</SpecialInstructions>
<CurrencyCode>GBP</CurrencyCode>
<ExchangeRate xsi:nil="true" />
<OrderLines>
<CreateOrderLineModel>
<OrderedProductSKU>PRODUCTSKU</OrderedProductSKU>
<OrderedProductName>Product Name</OrderedProductName>
<QuantityOrdered>1</QuantityOrdered>
<SingleItemPrice>1</SingleItemPrice>
<TotalItemPriceExVat>1</TotalItemPriceExVat>
<TotalItemPriceIncVat>1.2</TotalItemPriceIncVat>
<VatTotal>0.2</VatTotal>
<TaxRate>20</TaxRate>
<Discount xsi:nil="true" />
<ItemOptions>Engraved with customer's name</ItemOptions>
</CreateOrderLineModel>
</OrderLines>
<ShipByDate xsi:nil="true" />
<SetAsOnHold xsi:nil="true" />
</CreateOrderModel>
</ArrayOfCreateOrderModel>
Response Information
Resource Description
This allows you to import orders in bulk. You can only import a maximum of 5 orders at once.
Collection of CreateOrderResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| CreatedOrder | The Order that was imported | CreateOrderModel | None. |
| StoreFeederOrder | The order that was created in StoreFeeder | OrderModel | None. |
| Success | Whether the action was successful | boolean | None. |
| Error | Any errors that were received Success will always be false if an error is returned. | string | None. |
Response Formats
application/json, text/json
Sample:
[
{
"CreatedOrder": {
"ChannelId": 123456,
"ChannelOrderRef": "ORD200001",
"CustomerReference": "0001",
"BillingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"ShippingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"ShippingTotal": 0.0,
"PaymentMethod": "PayPal",
"PaymentID": "PAYREF0001",
"ChannelShippingMethod": "Channel Shipping Method 1",
"SpecialInstructions": "Do not bend",
"CurrencyCode": "GBP",
"OrderLines": [
{
"OrderedProductSKU": "PRODUCTSKU",
"OrderedProductName": "Product Name",
"QuantityOrdered": 1,
"SingleItemPrice": 1.0,
"TotalItemPriceExVat": 1.0,
"TotalItemPriceIncVat": 1.2,
"VatTotal": 0.2,
"TaxRate": 20.0,
"ItemOptions": "Engraved with customer's name"
}
]
},
"StoreFeederOrder": {
"OrderNumber": 21345,
"OrderGuid": "00000000-0000-0000-0000-000000000000",
"OrderStatus": "AwaitingPayment",
"Channel": {
"ChannelName": "Shopify UK",
"ChannelType": "Shopify",
"ChannelID": 1,
"ChannelGuid": "fd0578c5-3e70-4ed7-808e-87eb289785b2",
"IsActive": false
},
"ChannelOrderRef": "ORD200001",
"BillingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"IsPrime": false,
"IsPriority": false,
"IsAmazonBusiness": false,
"ChannelShippingMethod": "Channel Shipping Method 1",
"Weight": 0.0,
"Currency": "GBP",
"TaxExternallyCollected": false
},
"Success": true
},
{
"CreatedOrder": {
"ChannelId": 123456,
"ChannelOrderRef": "ORD200001",
"CustomerReference": "0001",
"BillingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"ShippingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"ShippingTotal": 0.0,
"PaymentMethod": "PayPal",
"PaymentID": "PAYREF0001",
"ChannelShippingMethod": "Channel Shipping Method 1",
"SpecialInstructions": "Do not bend",
"CurrencyCode": "GBP",
"OrderLines": [
{
"OrderedProductSKU": "PRODUCTSKU",
"OrderedProductName": "Product Name",
"QuantityOrdered": 1,
"SingleItemPrice": 1.0,
"TotalItemPriceExVat": 1.0,
"TotalItemPriceIncVat": 1.2,
"VatTotal": 0.2,
"TaxRate": 20.0,
"ItemOptions": "Engraved with customer's name"
}
]
},
"Success": false,
"Error": "Duplicate channel order reference specified."
}
]
application/xml, text/xml
Sample:
<ArrayOfCreateOrderResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CreateOrderResponse>
<Success>true</Success>
<CreatedOrder>
<ChannelId>123456</ChannelId>
<ChannelOrderRef>ORD200001</ChannelOrderRef>
<CustomerReference>0001</CustomerReference>
<BillingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</BillingAddress>
<ShippingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</ShippingAddress>
<ShippingTotal>0</ShippingTotal>
<OrderDate xsi:nil="true" />
<PaymentMethod>PayPal</PaymentMethod>
<PaymentID>PAYREF0001</PaymentID>
<ChannelShippingMethod>Channel Shipping Method 1</ChannelShippingMethod>
<SpecialInstructions>Do not bend</SpecialInstructions>
<CurrencyCode>GBP</CurrencyCode>
<ExchangeRate xsi:nil="true" />
<OrderLines>
<CreateOrderLineModel>
<OrderedProductSKU>PRODUCTSKU</OrderedProductSKU>
<OrderedProductName>Product Name</OrderedProductName>
<QuantityOrdered>1</QuantityOrdered>
<SingleItemPrice>1</SingleItemPrice>
<TotalItemPriceExVat>1</TotalItemPriceExVat>
<TotalItemPriceIncVat>1.2</TotalItemPriceIncVat>
<VatTotal>0.2</VatTotal>
<TaxRate>20</TaxRate>
<Discount xsi:nil="true" />
<ItemOptions>Engraved with customer's name</ItemOptions>
</CreateOrderLineModel>
</OrderLines>
<ShipByDate xsi:nil="true" />
<SetAsOnHold xsi:nil="true" />
</CreatedOrder>
<StoreFeederOrder>
<OrderNumber>21345</OrderNumber>
<OrderGuid>00000000-0000-0000-0000-000000000000</OrderGuid>
<OrderStatus>AwaitingPayment</OrderStatus>
<Currency>GBP</Currency>
<Channel>
<ChannelName>Shopify UK</ChannelName>
<ChannelType>Shopify</ChannelType>
<ChannelID>1</ChannelID>
<ChannelGuid>fd0578c5-3e70-4ed7-808e-87eb289785b2</ChannelGuid>
<IsActive>false</IsActive>
</Channel>
<ChannelOrderRef>ORD200001</ChannelOrderRef>
<ParentOrderNumber xsi:nil="true" />
<BillingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</BillingAddress>
<OrderDate xsi:nil="true" />
<AttentionIsRequired xsi:nil="true" />
<IsPrime>false</IsPrime>
<IsPriority>false</IsPriority>
<IsAmazonBusiness>false</IsAmazonBusiness>
<ImportDate xsi:nil="true" />
<ShipByDate xsi:nil="true" />
<DespatchDate xsi:nil="true" />
<DespatchSentToChannelDate xsi:nil="true" />
<DespatchOnChannelDate xsi:nil="true" />
<LastStatusChangeDate xsi:nil="true" />
<ChannelShippingMethod>Channel Shipping Method 1</ChannelShippingMethod>
<Weight>0</Weight>
<NumberOfPackages xsi:nil="true" />
<PickwaveID xsi:nil="true" />
<ExchangeRate xsi:nil="true" />
<CancelledDateUTC xsi:nil="true" />
<TaxExternallyCollected>false</TaxExternallyCollected>
</StoreFeederOrder>
</CreateOrderResponse>
<CreateOrderResponse>
<Success>false</Success>
<Error>Duplicate channel order reference specified.</Error>
<CreatedOrder>
<ChannelId>123456</ChannelId>
<ChannelOrderRef>ORD200001</ChannelOrderRef>
<CustomerReference>0001</CustomerReference>
<BillingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</BillingAddress>
<ShippingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</ShippingAddress>
<ShippingTotal>0</ShippingTotal>
<OrderDate xsi:nil="true" />
<PaymentMethod>PayPal</PaymentMethod>
<PaymentID>PAYREF0001</PaymentID>
<ChannelShippingMethod>Channel Shipping Method 1</ChannelShippingMethod>
<SpecialInstructions>Do not bend</SpecialInstructions>
<CurrencyCode>GBP</CurrencyCode>
<ExchangeRate xsi:nil="true" />
<OrderLines>
<CreateOrderLineModel>
<OrderedProductSKU>PRODUCTSKU</OrderedProductSKU>
<OrderedProductName>Product Name</OrderedProductName>
<QuantityOrdered>1</QuantityOrdered>
<SingleItemPrice>1</SingleItemPrice>
<TotalItemPriceExVat>1</TotalItemPriceExVat>
<TotalItemPriceIncVat>1.2</TotalItemPriceIncVat>
<VatTotal>0.2</VatTotal>
<TaxRate>20</TaxRate>
<Discount xsi:nil="true" />
<ItemOptions>Engraved with customer's name</ItemOptions>
</CreateOrderLineModel>
</OrderLines>
<ShipByDate xsi:nil="true" />
<SetAsOnHold xsi:nil="true" />
</CreatedOrder>
</CreateOrderResponse>
</ArrayOfCreateOrderResponse>