Request & 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-CustomerNumber:20-222222
          IM-CorrelationID: fbac82ba-cf0a-4bcf-fc03-0c508457f219-bw0a102j
          IM-CountryCode:US
          IM-SenderID:SampleUser-Best-Buy
          

Request Methods

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

• GET - request data for a resource(s)
• POST - request data OR create a resource(s)
• PUT - request to update a resource
• DELETE - request to delete a resource(s)

IMPORTANT: All POST and PUT calls will require JSON body as a payload. For endpoint specific examples, check out API Documentation. The customer number provided in the call must match the registered customer number. You will receive following error if the numbers do not match.

          {
            "faultcode": "Server",
            "faultstring": "Invalid customer number. The customer number provided on the API call does not match the registered customer number."
          }
          

Response Object

The below Header will always be:

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

Each response that returns from API will have the following top-level HTTP status code to indicate the nature of the response refer to HTTP Codes for full list of HTTP codes.

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}
          

Request Methods

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

• GET - request data for a resource(s)
• POST - request data OR create a resource(s)
• PUT - request to update a resource
• DELETE - request to delete a resource(s)

IMPORTANT: All POST and PUT calls will require "requestpreamble" object in the payload. For endpoint specific examples, check out API Documentation.

          "requestpreamble":
          {
          "isocountrycode={your 2 chars country code},
          "customernumber={your Ingram Micro customer number}",
          }
          

IMPORTANT: The customer number provided in the call must match the registered customer number. You will receive following error if the numbers do not match.

          {
            "faultcode": "Server",
            "faultstring": "Invalid customer number. The customer number provided on the API call does not match the registered customer number."
          }
          

Response Object

The Content-Type Header will always be:

application/json

Each response that return Body content will have the following top-level object:

serviceresponse, responsepreamble

          "responsepreamble":{
          "responsestatus": "SUCCESS",
          "statuscode": "200",
          "responsemessage": "Data Found",
          },