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
NameDescriptionTypeAdditional 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.
OrderLines This is a list of the details of each individual line in the order. Collection of CreateOrderLineModel Required

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
      }
    ]
  },
  {
    "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
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfCreateOrderModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <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" />
      </CreateOrderLineModel>
    </OrderLines>
  </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" />
      </CreateOrderLineModel>
    </OrderLines>
  </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
NameDescriptionTypeAdditional 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
        }
      ]
    },
    "StoreFeederOrder": {
      "OrderNumber": 21345,
      "OrderGuid": "00000000-0000-0000-0000-000000000000",
      "OrderStatus": 0,
      "Channel": {
        "ChannelName": "Ebay UK",
        "ChannelType": "Ebay",
        "ChannelID": 1,
        "ChannelGuid": "f2039b86-8f8c-4086-853b-81c163de010b",
        "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,
      "ChannelShippingMethod": "Channel Shipping Method 1",
      "Weight": 0.0,
      "Currency": "GBP"
    },
    "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
        }
      ]
    },
    "Success": false,
    "Error": "Duplicate channel order reference specified."
  }
]

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: There was an error generating the XML document.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: There was an error generating the XML document.