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-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 resource(s)
POST - request data OR create resource(s)
PUT - request to update resource(s)
DELETE - request to delete resource(s)

Important:

All POST and PUT calls will require JSON body as a payload. For endpoint specific examples, check out the 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 header will always be as shown below:

                
                    Content-Type:application/json
                    Accept:application/json
                    Authorization: Bearer {access-token}

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.

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 resource(s)
POST - request data OR create resource(s)
PUT - request to update resource(s)
DELETE - request to delete resource(s)

Important:

All POST and PUT calls will require "requestpreamble" object in the payload. For endpoint specific examples, check out the 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.

                
                    "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 the 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",
                        },

Request and Response