Orders with Gift Wrap Price & Message


When to Use

  • Orders with gift wrapping costs and custom messages defined by the buyer.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Orders?$expand=Items
GET https://api.channeladvisor.com/v1/Orders(ID)?$expand=Items

Important and/or Required Parameters

PropertyRequiredNote
IDOptionalOrder ID - include in URL.
Example Request
GET https://api.channeladvisor.com/v1/Orders(123456)?access_token=xxxxxxxxxx&$expand=Items
Example Response (Success)
200 OK
{
    "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Orders/$entity",
    "ID": 123456,
    "ProfileID": 12345678,
    "SiteID": 640,
    "SiteName": "Amazon Seller Central - US",
    "SiteAccountID": 1234,
    "SiteOrderID": "123-123456-123456",
    "SecondarySiteOrderID": null,
    "SellerOrderID": null,
    "CheckoutSourceID": null,
    "CreatedDateUtc": "2018-05-03T15:23:39Z",
    "ImportDateUtc": "2018-05-03T16:09:42.99Z",
    "PublicNotes": null,
    "PrivateNotes": "",
	// Additional properties omitted to save space.
    "Items": [
        {
            "ID": 123456,
            "ProfileID": 12345678,
            "OrderID": 654321,
            "ProductID": 123654,
            "SiteOrderItemID": "01010101010101",
            "SellerOrderItemID": null,
            "SiteListingID": "12345678",
            "Sku": "CHG4129",
            "Title": "Sterling Silver Necklace 18\"",
            "Quantity": 1,
            "UnitPrice": 30,
            "TaxPrice": 0,
            "ShippingPrice": 0,
            "ShippingTaxPrice": 0,
            "RecyclingFee": 0,
            "GiftMessage": "Dear John, HAPPY FIRST MOTHER'S DAY!  With  love, Mom and Dad",
            "GiftNotes": "Bailey's Wrapping Paper",
            "GiftPrice": 4.99,
            "GiftTaxPrice": 0,
            "IsBundle": false,
            "ItemURL": ""
        }
    ]
}