{
"openapi": "3.0.0",
"info": {
"title": "Invoice APIs",
"version": "5.0",
"description": "Ingram Micro APIs for invoice management.\n\n*Production URL - https://api.ingrammicro.com:443/resellers/v5*",
"contact": {
"name": "Customer Support",
"url": "https://developer.ingrammicro.com/contact"
}
},
"servers": [
{
"url": "https://api.ingrammicro.com:443/sandbox/resellers/v5",
"description": "Sandbox"
}
],
"paths": {
"/invoices/{invoiceNumber}": {
"get": {
"summary": "Get invoice details",
"operationId": "get-invoices",
"description": "View invoice details. This is a request to query invoice details for a specific Ingram Micro order placed in the last 9 months, whether open or shipped.\n\n invoiceNumber, isoCountryCode and customerNumber parameters are required.",
"security": [
{
"application": [
"read"
]
}
],
"tags": [
"invoices"
],
"parameters": [
{
"schema": {
"type": "string",
"default": "20-222222"
},
"in": "query",
"name": "customerNumber",
"description": "Your unique Ingram Micro customer number",
"required": true
},
{
"schema": {
"type": "string",
"maxLength": 2,
"default": "US",
"minLength": 2
},
"in": "query",
"name": "isoCountryCode",
"description": "ISO 2 char country code",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoiceDetails"
},
"examples": {
"Example": {
"value": {
"serviceresponse": {
"responsepreamble": {
"responsestatus": "SUCCESS",
"statuscode": "200",
"responsemessage": "Invoice Found"
},
"invoicedetailresponse": {
"invoicenumber": "RCW67-11",
"customerordernumber": "ZFEDRGT",
"customerfreightamount": "0.00",
"customerforeignfrightamt": "0.00",
"totaltaxamount": "0",
"totalamount": "61.22",
"shiptosuffix": "200",
"billtosuffix": "000",
"billto": {
"name1": "INGRAM MICRO CAPS TEST ACCOUNT",
"addressline1": "1759 WEHRLE DR",
"city": "WILLIAMSVILLE",
"state": "NY",
"postalcode": "142217033",
"countrycode": "US"
},
"paymentterms": "200",
"orderdate": "2020-01-06",
"carrier": "OT",
"carrierdescription": "OTHER",
"discountamount": "0.00",
"enduserponumber": null,
"freightforwardercode": null,
"creditmemoreasoncode": null,
"holdreason": null,
"shipcomplete": null,
"shipdate": "2020-01-06",
"companycurrency": "USD",
"currencycode": "USD",
"currencyrate": "1.000000",
"globalorderid": "20-RCW67-11",
"originalshipcode": null,
"orderstatus": "I",
"shiptoaddress": {
"name1": "INGRAM MICRO TEST ACCOUNT",
"addressline1": "ATTN TOD DEBIE",
"addressline2": "1610 E SAINT ANDREW PL",
"city": "SANTA ANA",
"state": "CA",
"postalcode": "927054931",
"countrycode": "US"
},
"totalsales": "61.22",
"weight": "5.00",
"lines": [
{
"linenumber": "1",
"partnumber": "123511",
"vendorpartnumber": "F2A032-06",
"partdescription": "666 PARALLEL PRINTER DB25M TO CABLCENT36M PRO SERIES 28AWG ROHS",
"shipfrombranch": "10",
"shippedquantity": "1",
"orderedquantity": "1",
"backorderquantity": "0",
"extendedprice": "30.61",
"specialbidnumber": null,
"ordersuffix": "11",
"unitprice": "30.61",
"unitofmeasure": "EA",
"productextendedspecs": [
{
"attributename": "commenttext",
"attributevalue": "EU#-001599983 ASPECT AUTOMATION LLMC#C"
}
]
},
{
"linenumber": "2",
"partnumber": "123511",
"vendorpartnumber": "F2A032-06",
"partdescription": "666 PARALLEL PRINTER DB25M TO CABLCENT36M PRO SERIES 28AWG ROHS",
"shipfrombranch": "10",
"shippedquantity": "1",
"orderedquantity": "1",
"backorderquantity": "0",
"extendedprice": "30.61",
"specialbidnumber": null,
"ordersuffix": "11",
"unitprice": "30.61",
"unitofmeasure": "EA",
"productextendedspecs": [
{
"attributename": "commenttext",
"attributevalue": "EU#-001599983 ASPECT AUTOMATION LLMC#C"
}
]
},
{
"linenumber": "3",
"partnumber": "123511",
"vendorpartnumber": "F2A032-06",
"partdescription": "666 PARALLEL PRINTER DB25M TO CABLCENT36M PRO SERIES 28AWG ROHS",
"shipfrombranch": "10",
"shippedquantity": "0",
"orderedquantity": "1",
"backorderquantity": "1",
"extendedprice": "0.00",
"specialbidnumber": null,
"ordersuffix": "11",
"unitprice": "30.61",
"unitofmeasure": "EA"
},
{
"linenumber": "895",
"vendorpartnumber": null,
"partdescription": "FREE FREIGHT",
"shipfrombranch": "10",
"shippedquantity": "0",
"orderedquantity": "0",
"backorderquantity": "0",
"extendedprice": "0.00",
"specialbidnumber": null,
"ordersuffix": "11",
"unitprice": "0",
"unitofmeasure": null
}
]
}
}
}
}
}
}
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"default": "20-RCW67-11"
},
"name": "invoiceNumber",
"in": "path",
"description": "Ingram Micro Invoice Number",
"required": true
}
]
}
},
"components": {
"securitySchemes": {
"application": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ingrammicro.com:443/oauth/oauth30/token",
"refreshUrl": "",
"scopes": {
"read": "allows reading resources",
"write": "allows modifying resources"
}
}
},
"description": ""
}
},
"schemas": {
"invoiceDetails": {
"title": "invoiceDetails.Response",
"type": "object",
"x-tags": [
"invoices"
],
"properties": {
"serviceresponse": {
"type": "object",
"properties": {
"responsepreamble": {
"type": "object",
"properties": {
"responsestatus": {
"type": "string"
},
"statuscode": {
"type": "string"
},
"responsemessage": {
"type": "string"
}
}
},
"invoicedetailresponse": {
"type": "object",
"properties": {
"customernumber": {
"type": "string"
},
"invoicenumber": {
"type": "string"
},
"invoicedate": {
"type": "string",
"format": "date"
},
"invoicetype": {
"type": "string"
},
"customerordernumber": {
"type": "string"
},
"customerfreightamount": {
"type": "string",
"format": "double"
},
"customerforeignfrightamt": {
"type": "string",
"format": "float"
},
"totaltaxamount": {
"type": "string",
"format": "double"
},
"totalamount": {
"type": "string",
"format": "double"
},
"shiptosuffix": {
"type": "string"
},
"billtosuffix": {
"type": "string"
},
"freightamount": {
"type": "string",
"format": "double",
"description": "May not be available in all countries"
},
"paymentterms": {
"type": "string"
},
"orderdate": {
"type": "string",
"format": "date"
},
"carrier": {
"type": "string"
},
"carrierdescription": {
"type": "string"
},
"discountamount": {
"type": "number",
"format": "double"
},
"taxtype": {
"type": "string"
},
"enduserponumber": {
"type": "string"
},
"freightforwardercode": {
"type": "string"
},
"creditmemoreasoncode": {
"type": "string"
},
"fulfillmentflag": {
"type": "string"
},
"holdreason": {
"type": "string"
},
"shipcomplete": {
"type": "string"
},
"shipdate": {
"type": "string",
"format": "date"
},
"companycurrency": {
"type": "string"
},
"currencycode": {
"type": "string"
},
"currencyrate": {
"type": "string"
},
"globalorderid": {
"type": "string"
},
"originalshipcode": {
"type": "string"
},
"ordertype": {
"type": "string"
},
"orderstatus": {
"type": "string"
},
"totalotherfees": {
"type": "number"
},
"totalsales": {
"type": "string"
},
"weight": {
"type": "string"
},
"shippableswitch": {
"type": "string"
},
"soldto": {
"$ref": "#/components/schemas/addressType"
},
"billto": {
"$ref": "#/components/schemas/addressType"
},
"shoptoaddress": {
"$ref": "#/components/schemas/addressType"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productLineType"
}
},
"extendedspecs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributename": {
"type": "string"
},
"attributevalue": {
"type": "string"
}
}
}
},
"miscfeeline": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"chargeamount": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"addressType": {
"title": "invoiceDetails.addressType.Response",
"type": "object",
"properties": {
"attention": {
"type": "string"
},
"name1": {
"type": "string"
},
"name2": {
"type": "string"
},
"addressline1": {
"type": "string"
},
"addressline2": {
"type": "string"
},
"addressline3": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalcode": {
"type": "string"
},
"countrycode": {
"type": "string"
},
"fax": {
"type": "string"
},
"phonenumber": {
"type": "string"
},
"email": {
"type": "string"
}
},
"description": "Address type object",
"x-tags": [
"invoices"
]
},
"productLineType": {
"title": "invoiceDetails.productLineType.Response",
"type": "object",
"description": "Product line items object under each invoice",
"x-tags": [
"invoices"
],
"properties": {
"linenumber": {
"type": "string"
},
"linetype": {
"type": "string"
},
"partnumber": {
"type": "string"
},
"vendorpartnumber": {
"type": "string"
},
"partdescription": {
"type": "string"
},
"shipfrombranch": {
"type": "string"
},
"shippedquantity": {
"type": "string"
},
"orderedquantity": {
"type": "string"
},
"marginpercent": {
"type": "string"
},
"backorderquantity": {
"type": "string"
},
"backorderetadate": {
"type": "string",
"format": "date"
},
"extendedprice": {
"type": "string"
},
"specialbidnumber": {
"type": "string"
},
"ordersuffix": {
"type": "string"
},
"isacopapplied": {
"type": "string"
},
"unitprice": {
"type": "string"
},
"unitofmeasure": {
"type": "string"
},
"serialnumberdetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serialnumber": {
"type": "string"
},
"deliverynumber": {
"type": "string"
}
}
}
},
"trackingnumberdetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"trackingnumber": {
"type": "string"
}
}
}
},
"productextendedspecs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributename": {
"type": "string"
},
"attributevalue": {
"type": "string"
}
}
}
}
}
}
}
},
"tags": [
{
"name": "invoices",
"description": "Invoice management API endpoints"
}
]
}