Request and Response

Request Object

Each request to the Ingram Micro APIs MUST have the following headers:

  Content-Type:application/json
  Accept:application/json
  Authorization: Bearer {access-token}
  IM-PartnerID:US123456
  IM-CorrelationID: fbac82ba-cf0a-4bcf-fc03-0c508457f219-bw0a102j
  IM-CountryCode:US
  IM-SenderID:SampleUser

Request methods

Each resource must support at least one method. Some may support more than one.

  • GET - request data for resource(s)
  • POST - request data OR create resource(s)
  • PUT - request to update a resource
  • DELETE - request to delete resource(s)
    {
      "faultcode": "Server",
      "faultstring": "Invalid partner id. The partner id provided on the API call does not match the registered partner id."
    }
    

Response object

The header will always be as shown below:

    Content-Type:application/json
    IM-CorrelationID:fbac82ba-cf0a-4bcf-fc03-0c508457f219-bw0a102j
    IM-SenderID:SampleUser
    

Each response from the API will include a top-level HTTP status code which indicates the nature of the response. For a comprehensive list of these HTTP codes, please refer to the HTTP Codes section.