Get Order

The Orders API provides the capability of retrieving an order or list of orders, based on the query parameters provided in the request.

Swagger

         
swagger: '2.0'
info:
  x-ibm-name: orders
  title: Orders
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  oauth2:
    type: oauth2
    description: ''
    flow: accessCode
    authorizationUrl: 'https://<.........................>/fsc/oauth2/authorize'
    scopes:
      Fulfillment_Returns: ''
    tokenUrl: 'https://<.........................>/fsc/oauth2/token'
  Client_Secret:
    type: apiKey
    description: Enter Client Secret
    in: header
    name: X-IBM-Client-Secret
  Client_Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Enter Client ID
security:
  - Client_Secret: []
    Client_Id: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /orders:
    get:
      responses:
        200:
          description: 200 OK
      parameters:
      - name: AccessToken
        type: string
        required: false
        in: header
        description: Enter the AccessToken, it is mandatory
      - name: query_params
        type: string
        required: false
        in: query
        description: Enter all the query parameters
      summary: Get Order
      description: Retrieves an order or list of orders based on the query parameters
        provided in the request.

      

Sample Request

         
	•	Retrieve all order details using fedexOrderId
	https://<........>/api/v1/orders?fedexOrderId=0001-0007-H1230162729, 0001-0007-H1230162729
	•	Retrieve only basic order details of orders created on or after the timestamp provided 
	https://<........>/api/v1/orders?createdTimestamp=ge|2016-09-21T14:30:59-05:00&responseFilter=Basic
	•	Retrieve basic and fulfillment order details of orders that are either Shipped or Partially Shipped
	https://<........>/api/v1/orders?orderStatus=Shipped,Partially Shipped&responseFilter=Basic,Fulfillment

 
      

Sample Response

Success Response

         

{
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
  "transactionDate": "2017-01-20T15:12:54-05:00",
  "order": [
    {
      "orderNumber": "70009",
      "externalOrderNumber": "CAAMZ009",
      "fedexOrderId": "0001-0007-H1230162729",
      "orderDate": "2017-01-26T22:18:01-05:00",
      "orderType": "B2C",
      "shipMethod": "FSON",
      "estimatedDeliveryDate": "2017-08-15",
      "shipType": "PCL",
      "orderStatus": "Shipped",
      "cancelReasonCode": "",
      "salesChannel": "Amazon",
      "holdUntilDate": "2017-02-15T00:00:00-05:00",
      "facility": "HFY",
      "freightCost": 23.5,
      "insuranceCost": 10,
      "dutiesAndTaxes": 11.67,
      "alternatePackaging": true,
      "excludeCollateral": true,
"accessorial": [
      "COA",
      "SAT"
    	],
"dropShip": true,
      "externalRefIds":[
        {
          "idKey": "marketplaceId",
          "idValue": "453"
        },
        {
          "idKey": "vendorId",
          "idValue": "V234"
        },
        {
          "idKey": "tradingPartnerId",
          "idValue": "TP435"
        }
      ],
	"destinationAddress": {
	"company": "John Inc.",
        "name": "John Smith",
        "addressLine1": "1020 Orchard st",
        "addresLine2": null,
        "city": "SACRAMENTO",
        "stateCode": "CA",
        "zipCode": "95814-5704",
        "countryCode": "US",
        "email": "test85@gmail.com",
        "sendTrackingNumber": true, 
        "phoneNumber": "888-787-8888",     
        "shipToLocNumber": "433223",
        "storeNumber": "545423"
      },
      "orderNote": [
        {
          "noteCode": "NOTES",
          "noteText": "New Order"
        },
        {
          "noteCode": "GIFT_FROM",
          "noteText": "Johnson"
        },
        {
          "noteCode": "GIFT_TO",
          "noteText": "James"
        },
        {
          "noteCode": "GIFT_MESSAGE",
          "noteText": "Happy Birthday!!"
        }
      ],
      "line": [
        {
          "externalLineId": "001",
          "sku": "003-003-0001111",
          "unitPrice": "2.56",
          "orderedQty": "2",
          "orderedQtyUoM": "EA",
          "vendorSku": "TGTMEN0111",
          "upc": "614141000883",
          "gtin": "50614141000994"
        },
        {
          "externalLineId": "002",
          "sku": "005-001-0001",
	  "unitPrice": "2.56",
          "orderedQty": "2",
          "orderedQtyUoM": "EA",
          "vendorSku": "TGTMEN0133",
          "upc": "614141000012",
          "gtin": "10614141000029"
        }
      ],
      "fulfillment": [
        {
          "numberOfPallets": 1,
          "trackingDetails": [
            {
              "carrier": "FedEx",
              "trackNum": "719465507817",
              "trackUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=719465507817&cntry_code=us",
              "shipDate": "2017-01-26T22:18:01-05:00",
              "lpnNumber": "00021221321323",
	       "billOfLadingNumber": "BOL343434",
	  	"carrierProNumber": "FX44445552",
	        "weight": 3.4,
              	"weightUoM": "lbs",
              	"originFacility": "HFY",
              	"originFacilityAddress": {
                	"addressLine1": "700 Commerce Pkwy W Dr",
                	"addresLine2": null,
                	"city": "Greenwood",
                	"stateCode": "IN",
                	"zipCode": "46143",
                	"countryCode": "US"
              }
            }
          ],
          "line": [
            {
              "externalLineId": "001",
              "sku": "003-003-0001111",
              "shipQty": 1,
              "shipQtyUoM": "EA",
              "expirationDate": "2025-01-26T00:00:00-05:00",
              "serialNumbers": []
            },
            {
              "externalLineId": "002",
              "sku": "003-003-0001",
              "shipQty": 2,
              "shipQtyUoM": "EA",
              "expirationDate": "2025-01-26T00:00:00-05:00",
              "serialNumbers": [
                {
                  "serialNumber": "X00910181EW",
                  "quantity": 1
                },
                {
                  "serialNumber": " X00610155CE",
                  "quantity": 1
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "previous": "https://<..........>/api/v1/orders?pageLimit=25&orderStatus=Shipped&prevTimeStamp=1398995568",
    "next": "https://<..........>/api/v1/orders?pageLimit=25&orderStatus=Shipped&nextTimeStamp=1393899954"
  }
}

      

OAuth 2.0

Custom authentication

Query Parameters

Response Attribute

HTTP Status Code

Error Code

Shipment Methods

Shipment service levels