GET orders/{ordernumber}

Get a single order by Order Number.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ordernumber The Order Number you want to retrieve. integer Required

Body Parameters

None.

Response Information

Resource Description

Get a single order by Order Number.

OrderModel
NameDescriptionTypeAdditional information
OrderNumber This is the StoreFeeder Order Number. integer None.
OrderGuid This is the StoreFeeder Order GUID. globally unique identifier None.
OrderStatus This is the StoreFeeder Order Status ID. Statuses None.
Warehouse This is the Warehouse where the products in the order are stored. WarehouseBaseModel None.
Channel This is the Channel that the order was placed on. ChannelBaseModel None.
ChannelOrderRef This is the order reference that was supplied by the Channel. string None.
ParentOrderNumber This the order number of the original order that the order used to be part of if the order has been split, or the order number of the master order if the order has been merged. integer None.
OrderTotals This is the Order Total OrderTotalsModel None.
Customer This is the information StoreFeeder holds about the customer who placed the order. CustomerBaseModel None.
BillingAddress This is the billing address for the order. AddressModel None.
Shippingaddress This is the shipping address for the order. AddressModel None.
CouponCode This is the code that was provided for a discount coupon, if one was used. string None.
OrderDate This is the date that the order was placed. This is returned in UTC time. date None.
ImportDate This is the date that the order was imported into storefeeder. This is returned in UTC time. date None.
DespatchDate This is the date that the order was recorded as being despatched in StoreFeeder. This is returned in UTC time. date None.
DespatchSentToChannelDate This is the date that StoreFeeder submitted to the order Channel as the Despatched Date. This is returned in UTC time. date None.
DespatchOnChannelDate This is the date that was recorded on the order Channel as the Despatched Date. This is returned in UTC time. date None.
LastStatusChangeDate This is the date that the order status was last updated on StoreFeeder. 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.
ShippingMethod This is the Shipping Method applied to the order in StoreFeeder. ShippingMethodBaseModel None.
ShippingTrackingNumber This is the Tracking Number applied to the order by the courier. string None.
ShippedVia This is the courier that the order was shipped with. This information is provided to the Channel by StoreFeeder. string None.
ConsignmentNumber This is the Consignment Number of the consignment that the order is part of. string None.
Weight This is the weight of the order. decimal number None.
NumberOfPackages This is the number of packages that the order was shipped in. integer None.
Packaging This is the type of packaging that the order was shipped in. PackagingBaseModel None.
PickerName This is the name of the picker who picked the order in the warehouse. string None.
PickwaveID This is the ID of the pickwave that the order was assigned to in StoreFeeder integer None.
PickerInstructions This is a list of instructions for the picker. These are stored against the products in StoreFeeder. string None.
SpecialInstructions This is a list of any special instructions that were stored against the order. string None.
ContactNotes This is a list of Contact Notes stored against the order in StoreFeeder. Collection of ContactNoteModel None.
Currency This is the currency of the order. 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.
Transactions This is a list of the details of all transactions related to the order that are stored in StoreFeeder. Collection of TransactionModel None.
OrderLines This is a list of the details of each individual line in the order. Collection of OrderLineModel None.
CompanyIdentity CompanyIdentityBaseModel None.
Url The URL to access the object. string None.

Response Formats

application/json, text/json

Sample:
{
  "OrderNumber": 21345,
  "OrderGuid": "00000000-0000-0000-0000-000000000000",
  "OrderStatus": 0,
  "Channel": {
    "ChannelName": "Shopify UK",
    "ChannelType": "Shopify",
    "ChannelID": 1,
    "ChannelGuid": "cf2ec225-93fb-4223-a057-42891042789c",
    "IsActive": false
  },
  "ChannelOrderRef": "ORD200001",
  "BillingAddress": {
    "FirstName": "John",
    "LastName": "Smith",
    "Company": "Company name",
    "Address1": "the cottage",
    "Address2": "1 street name",
    "Department": "Department Name",
    "Suite": "Suite Name",
    "City": "City",
    "State": "State",
    "Postcode": "NG7 2RR",
    "Country": "United Kingdom",
    "PhoneNumber": "01234123456"
  },
  "ChannelShippingMethod": "Channel Shipping Method 1",
  "Weight": 0.0,
  "Currency": "GBP"
}

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.