{ "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Vendor API Documentation", "description": "For Vendors.
\nProvide Vendors with an API endpoint to update the status of an existing purchase order placed by Ingram Micro and being processed by the vendor.\n\n\n*Host Production URL - https://api.ingrammicro.com:443/vendors/v1 *\n" }, "tags": [ { "name": "Vendor PO Status", "description": "\nIngram Micro's Purchase Order Status API v1 endpoint enables vendors to:\n - Update status of the order during each step of the fulfillment process.\n - Update end users/customer on delivery ETAs.\n - Provide an advance shipment notification along with carrier and tracking details." }, { "name": "Vendor PO Response", "description": "\nThe Ingram Micro Purchase Order Response API v1 endpoint enable Vendors to:\n - Acknowledge / accept the order.\n - Accept the order with suggested changes.\n - Reject particular line items on the order.\n - Provide the end customer or distributor with estimated delivery dates.\n - Provide an active sales order number from the vendor." }, { "name": "Special Pricing", "description": "\nThe Special Bid Offering endpoint enables vendors to:\n - Send special pricing information to Ingram Micro.\n - See their bid number and bid version.\n - See their bid status--whether their bid has been accepted or rejected.\n - View line level details for the special pricing order." }, { "name": "Invoice Details", "description": "\nThe vendor Invoice API enables vendors to:\n - See invoice details.\n - View invoicing company address information.\n - View a comprehensive summary of the invoice broken down by.\n - See line level information in the invoice such as.\n - See Delivery information for the ship to and ship from addresses." }, { "name": "Proactive Renewal Quotes", "description": "\nAPI will create proactive quotes for the Resellers for up-coming renewals. RenewVue system will create opportunities, process the event as appropriate milestone is reached, and will notify resellers via quotes or reminders." }, { "name": "Quote number and status", "description": "\nFind quote number and status of a quote request by vendor reference id or IM provided transaction id. Multiple status values can be provided with comma separated strings" }, { "name": "PO Create Webhook", "x-displayName": "PO Create Webhook", "description": "\nIngram Micro Purchase Order v1 Webhook enables Vendors to:\n - Receive purchase orders in real-time by subscribing to the webhook.\n - Reduce manual purchase order submission.\n - Allows for immediate HTTP acknowledgement of receipt. " } ], "x-tagGroups": [ { "name": "Vendor APIs", "tags": [ "Vendor PO Response", "Vendor PO Status", "Special Pricing", "Invoice Details", "Proactive Renewal Quotes", "Quote number and status" ] }, { "name": "Webhook APIs", "tags": [ "PO Create Webhook" ] } ], "paths": { "/purchaseorders/{id}/statuses": { "post": { "summary": "Vendor Purchase Order Status", "tags": [ "Vendor PO Status" ], "description": "Ingram Micro Purchase Order Status API v1 endpoint enables vendors to update status of the order during each step of the fulfillment process, update end users/customer on delivery ETAs, provide an advance shipment notification along with carrier and tracking details.", "operationId": "post-vendorpurchaseorderstatus", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "IM-CountryCode", "in": "header", "description": "Two-character ISO country code.", "required": true, "schema": { "type": "string", "example": "BE" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique transaction number to identify each transaction accross all the systems.", "required": true, "schema": { "type": "string", "example": "fbac82ba-cf0a-4bcf-fc03-0c508457f219-bw0a102j" } }, { "name": "IM-SenderID", "in": "header", "description": "Unique value used to identify the sender of the transaction.", "required": false, "schema": { "type": "string", "example": "MyCompany" } }, { "name": "IM-PartnerID", "in": "header", "description": "PartnerID", "required": true, "schema": { "type": "string", "example": "IN010721" } }, { "name": "id", "in": "path", "description": "Purchase order number.", "required": true, "schema": { "type": "string", "example": "35RF12D" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPOStatusRequest" }, "examples": { "Success": { "value": { "salesOrderNumber": "118909876", "salesOrderDate": "2020-11-20T08:54:39-07:00", "orderName": "ZEN TECHNOLOGIES REF#56789", "ingramPurchaseOrderNumber": "35RF12D", "ingramPurchaseOrderdate": "2020-11-19T08:54:39-07:00", "customerOrderNumber": "PO 123", "orderStatus": "SHIPPED", "orderTotal": 140.67, "currencyCode": "USD", "buyerInfo": { "billToPartnerId": "790990909", "companyName": "ingram Micro", "contact": "Jane Smith", "addressLine1": "123 Michelson dr", "addressLine2": "", "addressLine3": "", "city": "Anaheim", "state": "CA", "postalCode": "92612", "countryCode": "US", "phoneNumber": "1231231234", "email": "abc@ingrammicro.com" }, "resellerInfo": { "vendorResellerId": "4654392202", "companyName": "Acme Electronics", "contact": "Jane Smith", "addressLine1": "123 Mickey Mouse Rd", "addressLine2": "", "addressLine3": "", "city": "Anaheim", "state": "CA", "postalCode": "94261", "countryCode": "US", "phoneNumber": "1231231234", "email": "abc@reseller.com" }, "shipmentDetails": { "carrierCode": "", "freightAccountNumber": "", "requestedDeliveryDate": "", "shipComplete": "Y", "shippingInstructions": "", "shipToInfo": { "billToPartnerId": "790990909", "contact": "Jane Smith", "companyName": "Acme Electronics", "addressLine1": "123 Mickey Mouse Rd", "addressLine2": "", "addressLine3": "", "city": "Anaheim", "state": "CA", "postalCode": "94261", "countryCode": "US", "phoneNumber": "1231231234", "email": "abc@shiptoinfo.com" } }, "endUserInfo": { "vendorEndUserId": "123456", "companyName": "Abc Technologies", "contact": "John Doe", "addressLine1": "123 starry night street", "addressLine2": "", "addressLine3": "", "city": "Anaheim", "state": "CA", "postalCode": "48201", "countryCode": "US", "phoneNumber": "1231231234", "email": "abc@enduser.com" }, "lines": { "ingramLineNumber": "1", "lineStatus": "SHIPPED", "ingramPartNumber": "6LL243", "vendorPartNumber": "PWR-C1-1100WAC-UP", "partDescription": "UPG OPTION 1100W AC 80+ PLAT", "upcCode": "", "unitPrice": 472.5, "extendedPrice": 571252.5, "currencyCode": "USD", "quantityShipped": 10, "quantityOrdered": 10, "quantityUom": "EA", "quantityConfirmed": 10, "quantityBackOrdered": 10, "requestedDeliveryDate": "2020-04-22", "promisedDeliveryDate": "2020-04-22", "specialBidNumber": "654321", "shipmentDetails": { "salesOrderLineNumber": "001", "shipmentStatus": "SHIPPED", "shipmentNumber": "1", "quantity": 10, "estimatedShipDate": "2020-04-19", "invoiceNumber": "", "invoiceDate": "", "carrierCode": "FO", "carrierName": "FEDEX OVERNIGHT", "carrierService": "LTL/AIRH/STANDARD", "shippingMethod": "A", "trackingNumber": "1102479435", "trackingUrl": "https: //www.fedex.com/apps/fedextrack/?action=track&trackingnumber=45434543454&cntry_code=US", "actualShipDate": "2020-04-19", "estimatedDeliveryDate": "", "actualDeliveryDate": "2020-04-19", "packageWeight": 110.9, "cartonNumber": "9999999999999999999", "quantityInBox": 5, "shipFrom": { "addressLine1": "abc street", "addressLine2": "", "addressLine3": "", "city": "IRVINE", "state": "CA", "postalCode": "037432247", "countryCode": "US" }, "serialNumbers": [ { "serialNumber": "FDA782538X", "imei": "31437983471" }, { "serialNumber": "FOO123456Y", "imei": "31437983472" }, { "serialNumber": "FDA782538X", "imei": "31437983473" }, { "serialNumber": "FOO123456Y", "imei": "31437983474" }, { "serialNumber": "FDA782538X", "imei": "31437983475" } ], "proofOfDelivery": [ { "signedByName": "pawan" } ] }, "additionalAttributes": [ { "attributeName": "", "attributeValue": "" } ] }, "additionalAttributes": [ { "attributeName": "", "attributeValue": "" } ], "additionalValidation": true } } } } } }, "responses": { "200": { "description": "OK", "headers": { "IM-CorrelationID": { "schema": { "type": "string" }, "description": "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID": { "schema": { "type": "string" }, "description": "Unique value used to identify the sender of the transaction. Example: MyCompany" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPOStatusError" }, "examples": { "Single Error": { "value": { "errors": [ { "id": "AxYqwpeo=sa-Fgwh", "type": "/errors/validation-failed", "message": "Validation failed", "fields": [ { "field": "carrierCode", "message": "carrierCode can not be blank" }, { "field": "carrierName", "message": "carrierName can not be blank" }, { "field": "shippingMethod", "message": "shippingMethod can not be blank" }, { "field": "trackingNumber", "message": "trackingNumber can not be blank" }, { "field": "actualShipDate", "message": "actualShipDate can not be blank" }, { "field": "actualDeliveryDate", "message": "actualDeliveryDate can not be blank" }, { "field": "cartonNumber", "message": "cartonNumber can not be blank" }, { "field": "quantityInBox", "message": "quantityInBox can not be blank " } ] } ] } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPOStatusError" }, "examples": { "Server Error": { "value": { "errors": [ { "id": "C123-bw0a10u3-2021-02-19T11:12:26.436-08:00", "type": "/errors/system-errors", "message": "Some unexpected error occured, please contact support team for more details" } ] } } } } } } } } }, "/purchaseorders/{id}/acknowledgement": { "post": { "summary": "Vendor Purchase Order Response", "tags": [ "Vendor PO Response" ], "description": "\"The Ingram Micro Purchase Order Response API v1 endpoint enable Vendors to acknowledge / accept the order, accept the order with suggested changes, reject particular line items on the order, provide the end customer or distributor with estimated delivery dates, provide an active sales order number from the vendor.\"", "operationId": "", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "IM-CountryCode", "in": "header", "description": "Two-character ISO country code.", "required": true, "schema": { "type": "string", "example": "BE" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique transaction number to identify each transaction accross all the systems.", "required": true, "schema": { "type": "string", "example": "fbac82ba-cf0a-4bcf-fc03-0c508457f219-bw0a102j" } }, { "name": "IM-SenderID", "in": "header", "description": "Unique value used to identify the sender of the transaction.", "required": false, "schema": { "type": "string", "example": "Best Buy" } }, { "name": "IM-PartnerID", "in": "header", "description": "PartnerID", "required": true, "schema": { "type": "string", "example": "IN010721" } }, { "name": "id", "in": "path", "description": "id.", "required": true, "schema": { "type": "string", "example": "35RF12D" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPOAcknowledgementRequest" }, "examples": { "Success": { "value": { "ingramPurchaseOrderNumber": "40HJ600123", "ingramPurchaseOrderDate": "2021-07-20T00:00:00", "resellerCompanyName": "ABC TECHNOLOGIES", "purchaseOrderAckDate": "2021-07-22T22:21:07.9761602Z", "orderStatus": "ACCEPTED", "salesOrderNumber": "1189097364", "salesOrderDate": "2020-11-21T08:00:00-07:00", "orderDescription": "", "lines": [ { "ingramLineNumber": "1", "vendorPartNumber": "451-BBWK", "ingramPartNumber": "6DG130", "partDescription": "65WHR 6CELL LI-ION BATTERY BATT", "vendorLineNumber": "1", "lineStatus": "ACCEPTED", "statusDescription": "", "unitPrice": 0, "quantityOrdered": 13, "quantityUom": "EA", "quantityConfirmed": 13, "quantityBackordered": 0, "estimatedShipDate": "2021-07-21T15:11:24", "estimatedDeliveryDate": "2021-07-26T15:11:24", "quantityRejected": 0, "rejectionDate": "" }, { "ingramLineNumber": "2", "vendorPartNumber": "JDV23", "ingramPartNumber": "Infinity", "partDescription": "WD15 DELL 4K DOCK 130W AC DOCK", "lineStatus": "ACCEPTED", "unitPrice": 0, "quantityOrdered": 12, "quantityUom": "EA", "quantityConfirmed": 12, "quantityBackordered": 0, "backorderedEtaDate": "2021-07-30T00:00:00", "estimatedShipDate": "2021-07-21T15:24:44", "estimatedDeliveryDate": "2021-07-26T15:24:44", "quantityRejected": 0, "rejectionDate": "" }, { "ingramLineNumber": "3", "vendorPartNumber": "452-BCNU", "ingramPartNumber": "8W6330", "partDescription": "TB16 THUNDERBOLT 240W DOCK", "lineStatus": "ACCEPTED", "unitPrice": 0, "quantityOrdered": 4, "quantityUom": "EA", "quantityConfirmed": 4, "quantityBackordered": 0, "estimatedShipDate": "2021-07-21T15:07:49", "estimatedDeliveryDate": "2021-07-26T15:07:49", "quantityRejected": 0 } ] } } } } } }, "responses": { "200": { "description": "OK", "headers": { "IM-CorrelationID": { "schema": { "type": "string", "description": "Unique transaction number identify each transaction across all the systems." } }, "IM-SenderID": { "schema": { "type": "string", "description": "Unique value used to identify the sender of the transaction.", "example": "MyCompany" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPOAcknowledgementError" }, "examples": { "Single Error": { "value": { "errors": [ { "id": "AxYqwpeo=sa-Fgwh", "type": "/errors/validation-failed", "message": "Validation failed", "fields": [ { "field": "ingramPurchaseOrderNumber", "message": "ingramPurchaseOrderNumber can not be blank" }, { "field": "ingramPurchaseOrderDate", "message": "ingramPurchaseOrderDate can not be blank" }, { "field": "salesOrderNumber", "message": "salesOrderNumber can not be blank when orderStatus is ACCEPTED or ACCEPTED WITH CHANGES" }, { "field": "salesOrderCreatedDate", "message": "salesOrderCreatedDate can not be blank" }, { "field": "vendorPartNumber", "message": "vendorPartNumber can not be blank" } ] } ] } }, "Multiple Errors": { "value": { "errors": [ { "id": "-bw0a10t1-2021-02-19T11:04:37.312-08:00", "type": "validation error", "message": "cvc-simple-type.?: The initial value '' for element '{http://tns.tibco.com/bw/json/1609324568935}lineStatus' is not valid with respect to the simple type definition '{anonymous}'" } ] } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPOAcknowledgementError" }, "examples": { "Server Error": { "value": { "errors": [ { "id": "C123-bw0a10u3-2021-02-19T11:12:26.436-08:00", "type": "/errors/system-errors", "message": "Some unexpected error occured, please contact support team for more details. " } ] } } } } } } } } }, "/specialpricing": { "post": { "summary": "Special Pricing", "tags": [ "Special Pricing" ], "description": "The Special Bid Offering endpoint enables vendors to\n* Send special pricing information to Ingram Micro\n* Send discount/special pricing information\n* Send contract dates, and payment terms\n* Send line level pricing information\n* See their bid number and bid version\n* See their bid status--whether their bid has been accepted or rejected\n* View line level details for the special pricing order", "operationId": "post-vendors-specialpricing", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "IM-partnerId", "in": "header", "description": "Ingram Micros code for the vendor", "required": true, "schema": { "type": "string", "example": 72 } }, { "name": "IM-countryCode", "in": "header", "description": "Country for the special pricing", "required": true, "schema": { "type": "string", "example": "US" } }, { "name": "IM-customerNumber", "in": "header", "description": "Vendor's account number for Ingram Micro", "required": false, "schema": { "type": "string", "example": 412333473 } }, { "name": "IM-correlationId", "in": "header", "description": "Vendor's ID for this transaction", "required": true, "schema": { "type": "string", "example": "ABCD1272305809324ABCD1272305809324ABCD127230580932" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPricingRequest" }, "examples": { "success": { "value": { "vendorName": "Samsung", "programName": "Ergotron Deal Registration", "programAction": "N", "programType": "N", "bidNumber": "", "bidVersion": "", "bidStartDate": "Jul 16, 2021 12:08:59 AM", "bidEndDate": "Jul 29, 2021 12:08:59 AM", "bidNotes": "", "bidTerms": "", "bidSpecialTerms": "", "bidValue": "", "bidPrice": "123.34", "paymentTerms": "", "quoteNumber": "A1234777", "resellerAccountNumber": "123886", "enduserAccountNumber": "1", "dealRegistration": true, "dealRegistrationNumber": "123886", "representativeName": "Jim Nevel", "representativeEmail": "jim.nevel@vendor.com", "noOfPayments": "12", "billingCycle": "monthly", "quoteTerm": "12 months", "committedTerm": "15 months", "customerPurchasingContract": "SLED", "lines": [ { "lineNumber": "2", "vendorPartNumber": "A1234777", "ingramPartNumber": "654123", "productDescription": "", "minQuantity": "4", "maxQuantity": "100", "listPrice": 123.45, "msrp": 123.45, "standardCost": "127.77", "discountType": "SOCOST", "discount": 10, "imStandardDiscount": 107.78, "imAdditionalDiscount": 20.58, "resellerPrice": 127.77, "resellerStandardDiscount": 50, "resellerAdditionalDiscount": 20, "SalesAgreementNumber": "6502027496", "CTOFlag": "No", "TransactionType": "ZCLB", "TransactionDescription": "Multi-Country - Backend Local Contract", "LineStartDate": "2023-07-06", "LineEndDate": "2024-01-24", "Category": "Audio", "IsExpired": false, "OrderableFlag": "Yes", "OrderableStatus": "Active", "TopReseller": "Y", "CoverageStartDate": "2023-07-06", "CoverageEndDate": "2024-01-24", "renewalIdentifiers": [ { "renewalIdentifierType": "L", "renewalIdentifierValue": "2504587", "renewalStartDate": "Jul 29, 2021 12:08:59 AM", "renewalEndDate": "Jul 29, 2021 12:08:59 AM", "renewalTermLength": 365 } ] } ], "resellerInfo": [ { "contact": "Sarah Smith", "companyName": "ABC Company", "addressLine1": "123 Main Street", "addressLine2": "Ste 100", "addressLine3": "", "city": "Irvine", "state": "CA", "postalCode": "92712", "countryCode": "US", "phoneNumber": "9495555555", "email": "test@test.com", "PartnerLevel": "Gold", "PartnerNumber": "1214292497" }, { "contact": "Jo Smith", "companyName": "XYZ Company", "addressLine1": "121 Main Street", "addressLine2": "Ste 101", "addressLine3": "", "city": "Irvine", "state": "CA", "postalCode": "92712", "countryCode": "US", "phoneNumber": "9495555554", "email": "testing@test.com", "PartnerLevel": "Silver", "PartnerNumber": "12142292497", "secondaryContactName": "Raj", "secondaryContactEmail": "Raj@gmail.com;test@eml.com" } ], "endUserInfo": { "contact": "Sarah Smith", "companyName": "ABC Company", "addressLine1": "123 Main Street", "addressLine2": "Ste 100", "addressLine3": "", "city": "Irvine", "state": "CA", "postalCode": "92712", "countryCode": "US", "phoneNumber": "9495555555", "email": "test@test.com" } } } } } } }, "responses": { "200": { "description": "a VendorPricingResponseElement to be returned", "content": { "application/json": { "examples": { "Successful response": { "value": { "bidNumber": "", "bidVersion": "", "bidStatus": "Rejected", "headers": [ { "field": "currencyCode", "message": "Required field is missing" } ], "lines": [ { "lineNumber": "2", "vendorPartNumber": "A1234777", "lineStatus": "Rejected", "lineErrorMessage": "Missing start date" } ] } } }, "schema": { "$ref": "#/components/schemas/VendorPricingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPricingError" }, "examples": { "Validation error": { "value": { "errors": [ { "id": "74681b27-b1ea-454d-9847-d27059e19119", "type": "/errors/validation-failed", "message": "Validation failed", "fields": [ { "field": "currencyCode", "message": "Required field is missing" }, { "field": "programAction", "value": "S", "message": "Invalid Program Action" } ] } ] } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPricingError" }, "examples": { "Internal server error": { "value": { "errors": [ { "id": "bw0a1018-ABCD1272305809324ABCD1272305809324ABCD127230580932-2021-10-08T07:47:01.62-07:00", "type": "/errors/system-errors", "message": "Backend system timed out. Please try again later or contact Ingram Micro API Support team. " } ] } } } } } } } } }, "/invoices": { "post": { "summary": "", "tags": [ "Invoice Details" ], "description": "Allow vendors to post invoice details to Ingrammicro", "operationId": "Invoice Details", "parameters": [ { "name": "IM-CustomerNumber", "in": "header", "description": "Vendor's account number for Ingram Micro", "required": false, "schema": { "type": "string" } }, { "name": "IM-CountryCode", "in": "header", "description": "Country for the special pricing", "required": true, "schema": { "type": "string" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique number for this transaction", "required": true, "schema": { "type": "string" } }, { "name": "IM-PartnerID", "in": "header", "description": "Ingram Micros code for the vendor", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDetailsRequest" }, "examples": { "Success": { "value": { "invoiceType": "I", "payeeNumber": "497Y", "buyingCompanyName": "", "buyingCompanyNumber": "", "ingramPurchaseOrderNumber": "40-HKZ72-S", "ingramPurchaseOrderDate": "2021-09-10T14:04:42", "vendorInvoiceNumber": "ST-0000040920", "vendorInvoiceDate": "2021-10-06T14:04:42", "InvoiceComments": "", "shipmentDetails": { "shipDate": "2021-10-06T14:04:42", "carrierCode": "UPSN", "carrierName": "UPS GROUND", "carrierBillOfLading": "1Z12341456", "freightOnBoard": "", "cartonCount": "12", "weight": "125.2", "weightUom": "lb" }, "summary": { "netAmount": "4272.86", "netDueDays": "90", "netDueDate": "2021-12-31T14:04:42", "freightAmount": "72.88" }, "invoicingCompanyAddressInfo": { "companyName": "SOURCING SOLUTIONS", "addressLine1": "3183 RED HILL AVE", "addressLine2": "3351 Michelson Dr", "addressLine3": "Ste 100", "city": "COSTA MESA", "state": "CA", "postalCode": "92712", "countryCode": "US" }, "shipFromInfo": { "companyName": "SOURCING SOLUTIONS", "addressLine1": "3183 RED HILL AVE", "addressLine2": "3351 Michelson Dr", "addressLine3": "Ste 100", "city": "COSTA MESA", "state": "CA", "postalCode": "92712", "countryCode": "US" }, "shipToInfo": { "companyName": "SOURCING SOLUTIONS", "addressLine1": "3183 RED HILL AVE", "city": "COSTA MESA", "state": "CA", "postalCode": "92712", "countryCode": "US" }, "lines": [ { "vendorLineNumber": "1", "vendorPartNumber": "M393A8G40AB2-CWE", "partDescription": "S64GB DDR4-3200 REGISTERED ECC MEM", "ingramLineNumber": "001", "ingramPartNumber": "7GH737", "quantityInvoiced": "3", "unitPrice": "385.88", "extendedPrice": "1157.64", "upcCode": "0889842008555", "quantityUom": "EA", "licenseKeys": "productKey" }, { "vendorLineNumber": "2", "vendorPartNumber": "SM-T390NZKAXAR", "partDescription": "SAMSUNG GALAXY TAB ACTIVE2", "ingramLineNumber": "002", "ingramPartNumber": "9DB541", "quantityInvoiced": "7", "unitPrice": "434.62", "extendedPrice": "3042.34", "upcCode": "0889842008555", "quantityUom": "EA", "licenseKeys": "productKey" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success": { "value": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDetailsError" }, "examples": { "Error": { "value": { "errors": [ { "id": "AxYqwpeo=sa-Fgwh", "type": "/errors/validation-failed", "message": "Validation failed", "fields": [ { "field": "invoiceType", "message": "invoiceType is mandatory" } ] } ] } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDetailsError" }, "examples": { "Error": { "value": { "errors": [ { "id": "AxYqwpeo=sa-Fgwh", "type": "/errors/system-error", "message": "Some unexpected error occured. Please contact Ingram Micro API Support for further analysis." } ] } } } } } } } } }, "/renewals/license/quotes": { "post": { "tags": [ "Proactive Renewal Quotes" ], "description": "Submit a new / modified version of a proactive renewal quote", "summary": "Proactive Renewal Quote", "operationId": "submitProactiveRenewal", "parameters": [ { "$ref": "#/components/parameters/CountryCode" }, { "$ref": "#/components/parameters/PartnerId" }, { "$ref": "#/components/parameters/ReferenceId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProactiveRenewalRequest" } } } }, "responses": { "201": { "description": "success response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } } } }, "/renewals/license/quotes/status": { "get": { "tags": [ "Quote number and status" ], "summary": "Quote Number and Status", "description": "Find quote number and status of a quote", "operationId": "getQuoteStatus", "parameters": [ { "$ref": "#/components/parameters/CountryCode" }, { "$ref": "#/components/parameters/PartnerId" }, { "$ref": "#/components/parameters/ReferenceId" }, { "$ref": "#/components/parameters/TransactionId" } ], "responses": { "201": { "description": "success response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } } } }, "/pocreatewebhook": { "post": { "summary": "PO Create Webhook", "tags": [ "PO Create Webhook" ], "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "x-hub-signature", "in": "header", "description": "Ingram Micro creates a signature token by use of a secret key + Event ID. The algorithm to generate the secret key is given at link https://developer-stage.ingrammicro.com/reseller/article/how-use-webhook-secret-key. Use the event Id in the below sample along with your secret key to generate the key. Alternatively, to send try this out, use a random text to see how it works", "required": true, "schema": { "type": "string", "example": "3LeaTfLE5FLj1FcYflwdwFosH4ADHmMbds6thtirGC3e9lEkF9/1pt4T2fQQGlxf40EznDBER0b60M75K6ZW0A==" } }, { "name": "targeturl", "in": "header", "description": "The webhook url where the request needs to sent.", "required": true, "schema": { "type": "string", "example": "https://59a2dc5368073ab42fd9a92e210a9fdb.m.pipedream.net/" } } ], "requestBody": { "required": true, "content": { "application/json": { "examples": { "Success": { "value": { "topic": "vendors/purchaseorders", "event": "im::vendorpocreate", "eventTimeStamp": "015345.961", "eventid": "PWO64ZWWXC7LKZQXTG", "resource": [ { "eventType": "IM::prod", "ingramPurchaseOrderNumber": "20ABC12D", "ingramPurchaseOrderDate": "2026-04-01", "resellerOrderNumber": "PO12345", "orderType": "stock order", "vendorQuoteNumber": "81357660", "paymentTerms": "45", "currencyCode": "USD", "orderTotal": 12481.14, "notes": "Header Notes", "dpasRating": "DX", "dpasProgramId": "C9", "buyerInfo": { "billToPartnerId": "US572177", "buyerName": "MATTHEW SMITH", "companyName": "INGRAM MICRO INC.", "contact": "MATTHEW SMITH", "addressLine1": "3351 MICHELSON DR STE 100", "addressLine2": "5678 ADDRESS LINE 2", "city": "IRVINE", "state": "CA", "postalCode": "926120697", "countryCode": "US", "phoneNumber": "7145661000", "email": "MATTHEW.SMITH@INGRAMMICRO.COM" }, "resellerInfo": { "vendorResellerId": "4654392202", "companyName": "ACME ELECTRONICS", "contact": "MIKE MAISAL", "addressLine1": "123 MICKEY MOUSE RD", "addressLine2": "4567 ADDRESS LINE 2", "city": "ANAHEIM", "state": "CA", "postalCode": "802025995 ", "countryCode": "US", "phoneNumber": "1875691222", "email": "MIKE.MAISAL@RESELLER.COM" }, "shipmentDetails": { "carrierCode": "GR", "carrierService": "XXXX", "fobTerms": "ORIGIN", "fobPaymentTerms": "45", "freightAccountNumber": "8690594321", "requestedDeliveryDate": "2026-04-13", "shippingInstructions": [ { "shippingInstruction": "Shipping Instruction" } ], "shipToInfo": { "contact": "MIKE MAISAL", "companyName": "ACME ELECTRONICS", "addressLine1": "123 MICKEY MOUSE RD", "addressLine2": "4567 ADDRESS LINE 2", "city": "ANAHEIM", "state": "CA", "postalCode": "942610000", "countryCode": "US", "phoneNumber": "1875691222", "email": "MIKE MAISAL@RESELLER.COM" } }, "endUserInfo": { "vendorEndUserId": "6785392202", "companyName": "ABC TECHNOLOGIES", "contact": "JOHN TUCKER", "addressLine1": "123 NIGHT STREET BLVD", "addressLine2": "4567 ADDRESS LINE 2", "city": "DALLAS", "state": "TX", "postalCode": "754234909", "countryCode": "US", "phoneNumber": "1255471299", "email": "JOHN.TUCKER@ABC.COM" }, "lines": [ { "ingramLineNumber": "1", "vendorLineNumber": "Q-12345", "vendorPartNumber": "AM/A4018g-1YS", "vendorPartDescription": "1YR ALLYCARE SUPPORT FOR AM/A4018G-1YS", "ingramPartNumber": "6YQ517", "quantity": 2, "quantityUom": "EA", "unitPrice": 1939.43, "vendorNumber": "TST6", "UPCcode": "0810010074711", "unit": 1.0, "itemTotal": 4468.72, "specialBidNumber": "FTQ-123456", "secondaryBidNumber": "FTQ-123456", "serialNumbers": [ { "serialNumber": "B410-04282411" } ], "lineNotes": [ { "lineNote": "Line Comments" }, { "lineNote": "QUOTE NBR:81357660" } ], "hardwareId": "hardware1", "contractNumber": "1232123", "contractStartDate": "2026-05-08", "contractEndDate": "2026-05-10", "contractDuration": "24", "endUserInfo": { "endUserCompanyName": "ABC TECHNOLOGIES", "endUserContactName": "JOHN TUCKER", "endUserPhoneNumber": "1255471299", "endUserEmail": "JOHN.TUCKER@ABC.COM" } } ] } ] } } }, "schema": { "$ref": "#/components/schemas/POCreateWebhook" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } } }, "servers": [ { "url": "https://api.ingrammicro.com:443/sandbox/vendors/v1", "description": "Sandbox" } ], "components": { "parameters": { "CountryCode": { "name": "IM-CountryCode", "required": true, "in": "header", "schema": { "type": "string", "description": "2 char ISO country code, only countries in the list allowed.", "enum": [ "US", "UK", "DE" ], "default": "US", "example": "US" } }, "PartnerId": { "name": "IM-PartnerID", "in": "header", "required": true, "schema": { "type": "string", "description": "Unique identification number provided to client partner by IM after successful portal registration. Associated with a unique vendor id within IM systems.", "example": "US326380" } }, "ReferenceId": { "name": "IM-CorrelationID", "in": "header", "required": true, "schema": { "type": "string", "description": "Vendor generated unique reference number for this transaction", "example": "1Z3Y2E250313209925" } }, "TransactionId": { "name": "IM-TransactionId", "in": "header", "required": true, "schema": { "type": "string", "description": "IM generated unique id for transaction", "example": "3749234731520211630" } } }, "schemas": { "VendorPOStatusRequest": { "type": "object", "required": [ "salesOrderNumber", "ingramPurchaseOrderNumber", "ingramPurchaseOrderdate", "orderStatus", "lines" ], "properties": { "salesOrderNumber": { "type": "string", "description": "Vendor Sales order number created from Vendor system." }, "salesOrderDate": { "type": "string", "format": "date", "description": "Date order created in the vendor system in UTC format." }, "orderName": { "type": "string", "description": "The reseller-requested name or web order ID for the order." }, "ingramPurchaseOrderNumber": { "type": "string", "description": "Ingram Micro's Purchase Order number to the vendor." }, "ingramPurchaseOrderdate": { "type": "string", "format": "date", "description": "Ingram Micro's purchase order date and timestamp. The date is in UTC format corresponding to the date purchase order was created in Ingram Micro's system." }, "customerOrderNumber": { "type": "string", "description": "Reseller PO number provided to the vendor." }, "orderStatus": { "type": "string", "enum": [ "PROCESSING", "PARTIAL SHIPMENT", "SHIPPED", "BACKORDERED", "DELIVERED", "CANCELLED" ], "description": "\"The status of the purchase order. One of: Backordered, Processing, Shipped, Delivered, Cancelled, Partial Shipment.\"" }, "orderTotal": { "type": "number", "format": "float", "description": "The total price of the order." }, "currencyCode": { "type": "string", "description": "The country-specific three digit ISO 4217 currency code for the order." }, "buyerInfo": { "type": "object", "required": [ "contact", "companyName", "addressLine1", "city", "state", "postalCode", "countryCode" ], "description": "The address and contact information for the buyer.", "properties": { "billToPartnerId": { "type": "string", "enum": [ "Billing", "Shipping", "Install", "Enduser etc" ], "description": "The ID references the partner's address in the vendor's system for billing." }, "companyName": { "type": "string", "description": "Company name of the buyer." }, "contact": { "type": "string", "description": "Sales rep contact, contact name of buyer." }, "addressLine1": { "type": "string", "description": "Buyer street address." }, "addressLine2": { "type": "string", "description": "Buyer P.O box, etc." }, "addressLine3": { "type": "string", "description": "Buyer address line 3, any additional address details." }, "city": { "type": "string", "description": "The city the order will be billed to." }, "state": { "type": "string", "description": "The buyer's state." }, "postalCode": { "type": "string", "description": "The buyer's postal or zipcode." }, "countryCode": { "type": "string", "enum": [ "US", "AU" ], "description": "The buyer's two-character ISO country code." }, "phoneNumber": { "type": "string", "description": "The buyer's phone number." }, "email": { "type": "string", "description": "The buyer's email address." } } }, "resellerInfo": { "type": "object", "required": [ "contact", "companyName", "addressLine1", "city", "state", "postalCode", "countryCode" ], "description": "Object containing reseller address and contact information.", "properties": { "vendorResellerId": { "type": "string", "enum": [], "description": "The reseller's Id." }, "companyName": { "type": "string", "description": "The reseller's company name." }, "contact": { "type": "string", "description": "The reseller's contact name." }, "addressLine1": { "type": "string", "description": "The reseller's street address." }, "addressLine2": { "type": "string", "description": "Reseller's P.O.box, Building Number, etc." }, "addressLine3": { "type": "string", "description": "Additional reseller address information on line 3." }, "city": { "type": "string", "description": "The reseller's city." }, "state": { "type": "string", "description": "The reseller's state." }, "postalCode": { "type": "string", "description": "The reseller's zip or postal code." }, "countryCode": { "type": "string", "enum": [ "US", "AU" ], "description": "The resellers Country Code." }, "phoneNumber": { "type": "string", "description": "Reseller's contact phone number." }, "email": { "type": "string", "description": "Reseller's contact email address." } } }, "shipmentDetails": { "type": "object", "required": [], "description": "Object containing shipping/package details related to this purchase order.", "properties": { "carrierCode": { "type": "string", "description": "The code of the carrier for the shipment." }, "freightAccountNumber": { "type": "string", "description": "Customer provided freight account number. The freight account number is used to bill the shipping carrier directly from the reseller's account with the carrier." }, "requestedDeliveryDate": { "type": "string", "format": "date", "description": "The requested delivery date of the shipment, if this date is provided, then the customer is NOT expecting the delivery prior to this date. The requested delivery date is in UTC timestamp format. Delivery date is not guaranteed." }, "shipComplete": { "type": "boolean", "description": "Specifies whether the shipment will be shipped only when all products are fulfilled. The default is No." }, "shippingInstructions": { "type": "string", "description": "Notes or instructions given to carriers used for delivering this order. Contains additional shipping information for carriers to complete the order as specified." }, "shipToInfo": { "type": "object", "required": [ "contact", "companyName", "addressLine1", "city", "state", "postalCode", "countryCode" ], "description": "Object containing shipping/package details related to this purchase order.", "properties": { "billToPartnerId": { "type": "string", "description": "The ID references the partner's address in the vendor's system for billing." }, "contact": { "type": "string", "description": "Attention Name." }, "companyName": { "type": "string", "description": "Ship to company name." }, "addressLine1": { "type": "string", "description": "Ship to street address." }, "addressLine2": { "type": "string", "description": "Ship to building, PO box, apt number that the order will be delivered to." }, "addressLine3": { "type": "string", "description": "Ship to additional address details." }, "city": { "type": "string", "description": "Ship to city that the order will be delivered to." }, "state": { "type": "string", "description": "Ship to state that the order will be delivered to." }, "postalCode": { "type": "string", "description": "Ship to Postal or zipcode that the order will be delivered to." }, "countryCode": { "type": "string", "enum": [ "US", "AU" ], "description": "Ship to two-character ISO country code." }, "phoneNumber": { "type": "string", "description": "Ship to phone number." }, "email": { "type": "string", "description": "Ship to contact email address." } } } } }, "endUserInfo": { "type": "object", "required": [ "contact", "companyName", "addressLine1", "city", "state", "postalCode", "countryCode" ], "description": "This is the object containing end user contact and address information. The end user is the customer receiving the final product from the reseller/vendor.", "properties": { "vendorEndUserId": { "type": "string", "enum": [], "description": "The ID that references the end user/customer's address information in the vendor's system." }, "companyName": { "type": "string", "description": "End user company name." }, "contact": { "type": "string", "description": "End user contact name." }, "addressLine1": { "type": "string", "description": "End user street address." }, "addressLine2": { "type": "string", "description": "End user building, PO box, or apt number." }, "addressLine3": { "type": "string", "description": "Additional address information on line 3." }, "city": { "type": "string", "description": "The end user/customer's city." }, "state": { "type": "string", "description": "The end user/customer's state." }, "postalCode": { "type": "string", "description": "The end user/customer's zip or postal code." }, "countryCode": { "type": "string", "enum": [ "US", "AU" ], "description": "The end user/customer's two character ISO country code." }, "phoneNumber": { "type": "string", "description": "The end user/customer's phone number." }, "email": { "type": "string", "description": "The end user/customer's email." } } }, "lines": { "type": "array", "description": "Object containing line item information such as vendor part information, prices, contract information, etc.", "items": { "type": "object", "required": [ "lineStatus", "vendorPartNumber", "quantityOrdered", "quantityConfirmed", "promisedDeliveryDate", "ingramPartNumber" ], "properties": { "ingramLineNumber": { "type": "string", "description": "Unique Ingram line number for each line supplied on PO, starts with 001." }, "lineStatus": { "type": "string", "enum": [ "SHIPPED", "CANCELLED", "DELIVERED", "BACKORDERED", "PARTIAL SHIPMENT", "PROCESSING" ], "description": "The status for the line item in the order. One of: Backordered, Processing, Shipped, Delivered, Cancelled, Partial Shipment.
*Note: Value is required, if orderStatus is SHIPPED or PARTIAL SHIPMENT." }, "vendorPartNumber": { "type": "string", "description": "The vendor part number for the line item." }, "ingramPartNumber": { "type": "string", "description": "Unique Ingram Micro's part number for the vendor." }, "partDescription": { "type": "string", "description": "The vendor's description of the part in their system." }, "upcCode": { "type": "string", "description": "The UPC code for the line item. Consists of 12 numeric digits that are uniquely assigned to each trade item." }, "unitPrice": { "type": "number", "format": "float", "description": "Ingram Micro's agreed unit price of the line item." }, "extendedPrice": { "type": "number", "format": "float", "description": "Unit price X quantity for the line item." }, "quantityUom": { "type": "string", "description": "Unit of measure for the line item, describing how the quantity of the line items are divided. Example: each,license." }, "currencyCode": { "type": "string", "description": "The three-digit ISO currency code for the line item." }, "quantityOrdered": { "type": "integer", "description": "The quantity ordered of the line item." }, "quantityConfirmed": { "type": "integer", "description": "The quantity confirmed for the line item." }, "quantityBackOrdered": { "type": "integer", "description": "The quantity backordered for the line item." }, "quantityShipped": { "type": "integer", "description": "The quantity shipped for the line item.
*Note: Value is required, if orderStatus is 'SHIPPED' or 'PARTIAL SHIPMENT' and lineStatus is 'SHIPPED' or 'PARTIAL SHIPMENT'" }, "requestedDeliveryDate": { "type": "string", "format": "date", "description": "The requested delivery date in UTC format. Delivery date is not guaranteed." }, "promisedDeliveryDate": { "type": "string", "format": "date", "description": "The delivery date Ingram Micro promises. Date is in UTC format ." }, "specialBidNumber": { "type": "string", "description": "vendor bid number ( special pricing number)." }, "shipmentDetails": { "type": "array", "items": { "type": "object", "required": [ "shipmentStatus", "quantity" ], "description": "Object containing shipping/package details related to this purchase order.", "properties": { "salesOrderLineNumber": { "type": "string", "description": "Vendor sales order line number." }, "shipmentStatus": { "type": "string", "enum": [ "SHIPPED", "INVOICED" ], "description": "The shipment status. One of: Accepted, Rejected, Shipped, Invoiced." }, "shipmentNumber": { "type": "string", "description": "Internal shipment number from vendor (could be shipset number or some vendors can send vendor sales order number in this field).
*Note: Value is required, if orderStatus and lineStatus is 'SHIPPED'" }, "quantity": { "type": "integer", "description": "Total shipped quantity" }, "estimatedShipDate": { "type": "string", "format": "date", "description": "The estimated shipment date for the line item in UTC format." }, "invoiceNumber": { "type": "string", "description": "The vendor's invoice number for the order. Present when the order status is Invoiced/billed." }, "invoiceDate": { "type": "string", "format": "date", "description": "The date of the invoice for the order in UTC format. Present when the order status is Invoiced." }, "carrierCode": { "type": "string", "description": "Shipment Carrier Code containing the line item.
*Note: Value is required, if orderStatus is 'SHIPPED' or 'PARTIAL SHIPMENT' and lineStatus is 'SHIPPED' or 'PARTIAL SHIPMENT'" }, "carrierName": { "type": "string", "description": "The name of the carrier of the shipment containing the line item.
*Note: Value is required, if orderStatus is 'SHIPPED' or 'PARTIAL SHIPMENT' and lineStatus is 'SHIPPED' or 'PARTIAL SHIPMENT'" }, "carrierService": { "type": "string", "description": "This serves as an indicator if an ASN is Standard (SML) or LTL - for structure (SOPI/SOTI).:
*Note: Value is required, if orderStatus is 'SHIPPED' or 'PARTIAL SHIPMENT' and lineStatus is 'SHIPPED' or 'PARTIAL SHIPMENT'" }, "shippingMethod": { "type": "string", "enum": [ "A", "M", "G" ], "description": "Shipping method order will be delivered(Air,Motor Ground)." }, "trackingNumber": { "type": "string", "description": "Shipment tracking number from the carrier.
*Note: Value is required, if orderStatus is 'SHIPPED' or 'PARTIAL SHIPMENT' and lineStatus is 'SHIPPED' or 'PARTIAL SHIPMENT'" }, "trackingUrl": { "type": "string", "description": "Shipment tracking URL provided internally or by the carrier." }, "actualShipDate": { "type": "string", "format": "date", "description": "The date the line item was actually shipped in UTC format.
*Note: Value is required, if orderStatus is 'SHIPPED' or 'PARTIAL SHIPMENT' and lineStatus is 'SHIPPED' or 'PARTIAL SHIPMENT'" }, "estimatedDeliveryDate": { "type": "string", "format": "date", "description": "Estimated shipment date in UTC format. Delivery date not guaranteed." }, "actualDeliveryDate": { "type": "string", "format": "date", "description": "The date the line item is expected to be delivered in UTC format." }, "packageWeight": { "type": "string", "description": "The weight of the package for the line item." }, "cartonNumber": { "type": "string", "description": "The shipment carton number that contains the line item.
*Note: Value is required, if orderStatus is 'SHIPPED' or 'PARTIAL SHIPMENT' and lineStatus is 'SHIPPED' or 'PARTIAL SHIPMENT'" }, "quantityInBox": { "type": "integer", "description": "The quantity of line items in the box.
*Note: Value is required, if orderStatus is 'SHIPPED' or 'PARTIAL SHIPMENT' and lineStatus is 'SHIPPED' or 'PARTIAL SHIPMENT'" }, "shipFrom": { "type": "array", "items": { "type": "object", "required": [ "city", "state", "postalCode", "countryCode" ], "description": "Object that has address information the order will ship from.", "properties": { "addressLine1": { "type": "string", "description": "Street address order will ship from." }, "addressLine2": { "type": "string", "description": "Building or apt number order will ship from." }, "addressLine3": { "type": "string", "description": "Additional address information about where the order will ship from." }, "city": { "type": "string", "description": "City order will ship from." }, "state": { "type": "string", "description": "State order will ship from." }, "postalCode": { "type": "string", "description": "Postal or zipcode order will ship from." }, "countryCode": { "type": "string", "enum": [ "US", "AU" ], "description": "The ship from two-character ISO country code order will ship from." } } } }, "serialNumbers": { "type": "array", "items": { "type": "object", "description": "An array of objects containing serial numbers of the line items contained in the shipment.", "properties": { "serialNumber": { "type": "string", "description": "The serial number for the line item." }, "imei": { "type": "string", "description": "The imei number for the line item only in case of mobile." } } } }, "proofOfDelivery": { "type": "array", "items": { "type": "object", "description": "Array containing information about proof of delivery.", "properties": { "signedByName": { "type": "string", "description": "Signature provided by person for proof of delivery." } } } } } } }, "additionalAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "Line level custom field names." }, "attributeValue": { "type": "string", "description": "Value of the custom fields." } } } } } } }, "transactionType": { "type": "string", "description": "H02-IXAS2-TRANSACTION-TYPE Possible Value = 'AS'." }, "additionalAttributes": { "type": "array", "description": "Array containing custom fields from vendor on the order level.", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "Additional order specific fields will be added here in this key value pair) ex: commentlinetext etc" }, "attributeValue": { "type": "string", "description": "Data for the attribute name should be passed in this attribute value (this is the value pairing to the attribute name)." } } } }, "additionalValidation": { "type": "boolean", "description": "This activates the updated version of the initial data validation making a validation check line by line." } } }, "VendorPOStatusError": { "type": "object", "properties": { "errors": { "type": "array", "description": "An array of errors returned by API", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id to identify error." }, "type": { "type": "string", "description": "Describes the type of the error." }, "message": { "type": "string", "description": "Describes the error message." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Contains the name of the field." }, "message": { "type": "string", "description": "Gives the description of the message." }, "value": { "type": "string", "description": "Value sent in the input for the specified field." } } } } } } } } }, "VendorPOAcknowledgementRequest": { "type": "object", "required": [ "ingramPurchaseOrderNumber", "ingramPurchaseOrderdate", "purchaseOrderAckDate", "orderStatus", "salesOrderDate", "lines" ], "properties": { "ingramPurchaseOrderNumber": { "type": "string", "description": "Ingram PO number provided to the vendor." }, "ingramPurchaseOrderdate": { "type": "string", "format": "date", "description": "Ingram Micro's purchase order date and timestamp. The date is in UTC format corresponding to the date purchase order was created in Ingram Micro's system." }, "resellerCompanyName": { "type": "string", "description": "Reseller's company name." }, "purchaseOrderAckDate": { "type": "string", "format": "date", "description": "\"The date in UTC format that the purchase order was created in the vendor's system.\"" }, "orderStatus": { "type": "string", "enum": [ "ACCEPTED", "REJECTED", "ACCEPTED WITH CHANGES" ], "description": "Status of the vendor sales order . One of :ACCEPTED, REJECTED,ACCEPTED WITH CHANGES." }, "salesOrderNumber": { "type": "string", "description": "Unique vendor sales order number. Required when PO status is Accepted and Accepted with changes" }, "salesOrderDate": { "type": "string", "format": "date", "description": "Date sales order is created by vendor in UTC format." }, "orderDescription": { "type": "string", "description": "Description of the order / additional information about the order." }, "lines": { "type": "array", "description": "Object containing line item information such as vendor part information, prices, contract information, etc.", "items": { "type": "object", "required": [ "ingramLineNumber", "vendorPartNumber", "ingramPartNumber", "partDescription", "lineStatus", "unitPrice", "quantityOrdered", "quantityUom", "quantityBackOrdered", "estimatedShipDate", "estimatedDeliveryDate", "quantityRejected", "errors" ], "properties": { "ingramLineNumber": { "type": "string", "description": "Ingram line number sent on PO for a product. Unique Ingram Micro line number that starts with 001." }, "vendorPartNumber": { "type": "string", "description": "The vendor part number for the line item." }, "ingramPartNumber": { "type": "string", "description": "The Ingram Micro part number for the line item." }, "vendorLineNumber": { "type": "string", "description": "Line number assigned by vendor." }, "partDescription": { "type": "string", "description": "The vendor's description of the part in their system ex: Cellphone" }, "lineStatus": { "type": "string", "enum": [ "ACCEPTED", "REJECTED", "PRICE CHANGED", "BACK-ORDERED", "ON HOLD", "PENDING" ], "description": "The status of the line item.One of: Item Accepted, Item Backordered, Item Accepted - Changes Made, Item Accepted - Price Changed, Item Rejected." }, "statusDescription": { "type": "string", "description": "Description should be populated with reject reason if status is rejected, if the price changed or for any updates to the status." }, "unitPrice": { "type": "number", "format": "float", "description": "Ingram Micro's agreed unit price of the line item." }, "quantityOrdered": { "type": "integer", "description": "The quantity ordered of the line item." }, "quantityUom": { "type": "string", "description": "Unit of measure for the line item, describing how the quantity of the line items are divided. Example: each,license." }, "quantityConfirmed": { "type": "integer", "description": "Quantity confirmed to be shipped for the line item." }, "quantityBackOrdered": { "type": "integer", "description": "The quantity backordered for the line item." }, "backorderedEtaDate": { "type": "string", "format": "date", "description": "The estimated date that the line item will be back in stock in UTC format." }, "estimatedShipDate": { "type": "string", "format": "date", "description": "The estimated shipment date for the line item in UTC format." }, "estimatedDeliveryDate": { "type": "string", "format": "date", "description": "Estimated shipment date in UTC format. Delivery date not guaranteed." }, "quantityRejected": { "type": "integer", "description": "The quantity of the line item that was rejected." }, "rejectionDate": { "type": "string", "format": "date", "description": "The date the line item was rejected in UTC format." }, "errors": { "type": "array", "items": { "type": "object", "required": [ "field", "value" ], "description": "Object containing field level error information.", "properties": { "field": { "type": "string", "description": "Field name of where the error came from example: shippingInformation.carrierCode" }, "value": { "type": "string", "description": "Value of the error sent in request example: GR" }, "message": { "type": "string", "description": "Description of the error example: invalid carrier code" } } } } } } } } }, "VendorPOAcknowledgementError": { "type": "object", "properties": { "errors": { "type": "array", "description": "An array of errors returned by API", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id to identify error." }, "type": { "type": "string", "description": "Describes the type of the error." }, "message": { "type": "string", "description": "Describes the error message." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Contains the name of the field." }, "message": { "type": "string", "description": "Gives the description of the message." }, "value": { "type": "string", "description": "Value sent in the input for the specified field." } } } } } } } } }, "VendorPricingRequest": { "type": "object", "required": [ "vendorName", "programName", "programAction", "programType", "bidNumber", "bidVersion", "bidStartDate", "bidEndDate", "bidCurrency", "lines", "resellerInfo", "endUserInfo" ], "properties": { "vendorName": { "type": "string", "description": "Vendor’s name for the special pricing" }, "programName": { "type": "string", "description": "Vendor’s Program name for the special pricing" }, "programAction": { "type": "string", "description": "Create (N), update ( C ), Cancel (D)" }, "programType": { "type": "string", "description": "New (N), renewal (R), etc." }, "bidNumber": { "type": "string", "description": "Vendor's special pricing number" }, "bidVersion": { "type": "string", "description": "Vendor's version for this bid number" }, "bidStartDate": { "type": "string", "format": "date", "description": "Bid start date - Special bid starts on" }, "bidEndDate": { "type": "string", "format": "date", "description": "Bid end date - Special bid expires on" }, "bidNotes": { "type": "string", "description": "Bid notes - Additonal information that needs to be on the bid/quote" }, "bidTerms": { "type": "string", "description": "Bid terms and conditions" }, "bidSpecialTerms": { "type": "string", "description": "Any special terms" }, "bidValue": { "type": "integer", "description": "Holds the total opportunity value" }, "bidPrice": { "type": "integer", "description": "Quote price for Distis" }, "bidCurrency": { "type": "string", "description": "The currency used for the special pricing, this is a 3 dig code" }, "paymentTerms": { "type": "string", "description": "Payment terms and conditions" }, "quoteNumber": { "type": "string", "description": "Vendor's quote number" }, "resellerAccountNumber": { "type": "string", "description": "Vendor's number for the reseller" }, "enduserAccountNumber": { "type": "string", "description": "Vendor's number for the end user" }, "dealRegistration": { "type": "boolean", "description": "Flag for deal registration" }, "dealRegistrationNumber": { "type": "string", "description": "The deal reg number" }, "representativeName": { "type": "string", "description": "Name of the vendor's representative who created quote" }, "representativeEmail": { "type": "string", "description": "Email of the vendor's representative who created quote" }, "masterContract": { "type": "string", "description": "Master Contract" }, "opportunityID": { "type": "string", "description": "Opportunity ID" }, "noOfPayments": { "type": "string", "description": "Number of payments" }, "billingCycle": { "type": "string", "description": "Billing Cycle" }, "quoteTerm": { "type": "string", "description": "Quote Term" }, "committedTerm": { "type": "string", "description": "Committed Term" }, "customerPurchasingContract": { "type": "string", "description": "Customer Purchasing Contract" }, "additionalAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "Attribute Name" }, "attributeValue": { "type": "string", "description": "Attribute Value " } } } }, "lines": { "type": "array", "description": "Line level special pricing", "items": { "type": "object", "required": [ "lineNumber", "vendorPartNumber", "maxQuantity", "listPrice", "ingramCost", "discountType", "discount", "renewalIdentifiers" ], "properties": { "lineNumber": { "type": "string", "description": "Sequence number for each line. This can have child lines" }, "vendorPartNumber": { "type": "string", "description": "Vendor's Part number" }, "ingramPartNumber": { "type": "string", "description": "Ingram Micro's SKU number" }, "productDescription": { "type": "string", "description": "Vendor's description for the product" }, "minQuantity": { "type": "integer", "description": "Minimum quantity of product that must be ordered to receive this special pricing" }, "maxQuantity": { "type": "integer", "description": "Maximum quantity of product that can receive this special pricing" }, "listPrice": { "type": "integer", "description": "List price literally means the msrp price on the wholesale list. This may or may not be the same as MSRP" }, "msrp": { "type": "integer", "description": "Manufacturer's Suggested Retail Price" }, "ingramCost": { "type": "integer", "description": "This is the vendor's cost to Ingram Micro for the product on the special pricing" }, "discountType": { "type": "string", "description": "PRICE/DELTA/SOCOST" }, "discount": { "type": "integer", "description": "Can be %, Delta or new sales order cost" }, "imStandardDiscount": { "type": "integer", "description": "Disti Standard discount" }, "imAdditionalDiscount": { "type": "integer", "description": "Placeholder for additional Disti discount" }, "resellerPrice": { "type": "integer", "description": "Expected reseller price on the quotes" }, "resellerStandardDiscount": { "type": "integer", "description": "Reseller Standard discount" }, "resellerAdditionalDiscount": { "type": "integer", "description": "Placeholder for additional Reseller discount" }, "salesAgreementNumber": { "type": "string", "description": "Sales Agreement Number" }, "ctoFlag": { "type": "string", "description": "CTO Flag" }, "transactionType": { "type": "string", "description": "Transaction Type" }, "transactionDescription": { "type": "string", "description": "Transaction Description" }, "lineStartDate": { "type": "string", "format": "date", "description": "Line StartDate if different at line level or same Bid Date can be sent" }, "lineEndDate": { "type": "string", "format": "date", "description": "Line EndDate if different at line level or same Bid Date can be sent" }, "warranty": { "type": "string", "description": "Line Level Warranty" }, "category": { "type": "string", "description": "Product Brand / Category" }, "isExpired": { "type": "boolean", "description": "True or False" }, "orderableFlag": { "type": "string", "description": "Indicator to specify if Product is orderable or not" }, "topReseller": { "type": "string", "description": "Flag to indicate if top reseller" }, "orderableStatus": { "type": "string", "description": "Indicator to specify if orderable status of Product" }, "coverageStartDate": { "type": "string", "description": "Coverage Start Date" }, "coverageEndDate": { "type": "string", "description": "Coverage End Date" }, "renewalIdentifiers": { "type": "array", "description": "For renewals only - Type indicates whether it's a Contract, License, Serial, Instance Number", "items": { "type": "object", "required": [ "renewalIdentifierType", "renewalIdentifierValue", "renewalStartDate", "renewalEndDate", "renewalTermLength" ], "properties": { "renewalIdentifierType": { "type": "string", "description": "List item for Type. Can be C/L or Both" }, "renewalIdentifierValue": { "type": "string", "description": "For renewals only - Contract, License, Serial, Instance Number value for the type indicated" }, "renewalStartDate": { "type": "string", "format": "date", "description": "Renewal start date" }, "renewalEndDate": { "type": "string", "format": "date", "description": "Renewal end date" }, "renewalTermLength": { "type": "integer", "description": "Term length for renewal in days" } } } }, "additionalAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "Attribute Name" }, "attributeValue": { "type": "string", "description": "Attribute Value " } } } } } } }, "resellerInfo": { "type": "object", "required": [ "companyName" ], "description": "Reseller when they are on the bid.", "properties": { "contact": { "type": "string", "description": "Contact Name" }, "companyName": { "type": "string", "description": "Reseller/ EU name" }, "addressLine1": { "type": "string", "description": "Street address for delivery" }, "addressLine2": { "type": "string", "description": "Street address for delivery" }, "addressLine3": { "type": "string", "description": "Continuation of address line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or Region" }, "postalCode": { "type": "string", "description": "Zip code / Postal code" }, "countryCode": { "type": "string", "description": "Country of delivery" }, "phoneNumber": { "type": "string", "description": "contact phone number" }, "email": { "type": "string", "description": "contact email" }, "transactionNumber": { "type": "string", "description": "Transaction Number" }, "partnerLevel": { "type": "string", "description": "Partner Level" }, "partnerNumber": { "type": "string", "description": "Partner Number" } } }, "endUserInfo": { "type": "object", "required": [ "companyName" ], "description": "End User when they are on the bid.", "properties": { "contact": { "type": "string", "description": "Contact Name" }, "companyName": { "type": "string", "description": "Reseller/ EU name" }, "addressLine1": { "type": "string", "description": "Street address for delivery" }, "addressLine2": { "type": "string", "description": "Street address for delivery" }, "addressLine3": { "type": "string", "description": "Continuation of address line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or Region" }, "postalCode": { "type": "string", "description": "Zip code / Postal code" }, "countryCode": { "type": "string", "description": "Country of delivery" }, "phoneNumber": { "type": "string", "description": "contact phone number" }, "email": { "type": "string", "description": "contact email" } } } } }, "VendorPricingResponse": { "type": "object", "properties": { "bidNumber": { "type": "string", "description": "Accepted, if the request passes all the validation to be updated in the ERP system." } } }, "VendorPricingError": { "type": "object", "properties": { "errors": { "type": "array", "description": "An array of errors returned by API", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id to identify error." }, "type": { "type": "string", "description": "Describes the type of the error." }, "message": { "type": "string", "description": "Describes the error message." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Contains the name of the field." }, "message": { "type": "string", "description": "Gives the description of the message." }, "value": { "type": "string", "description": "Value sent in the input for the specified field." } } } } } } } } }, "InvoiceDetailsRequest": { "type": "object", "required": [ "invoiceType", "payeeNumber", "ingramPurchaseOrderNumber", "ingramPurchaseOrderDate", "vendorInvoiceNumber", "vendorInvoiceDate", "vendorOrderNumber", "shipToInfo", "lines", "shipmentDetails", "summary" ], "properties": { "invoiceType": { "type": "string", "description": "Field available to indicate invoice or credit memo. Debit/credit flag." }, "payeeNumber": { "type": "string", "description": "IM's code for the vendor. From Ingram to Vendor." }, "buyingCompanyName": { "type": "string", "description": "Ingram Micro." }, "buyingCompanyNumber": { "type": "string", "description": "Vendor's account number for Ingram Micro." }, "ingramPurchaseOrderNumber": { "type": "string", "description": "Ingram Micro's PO number to the vendor ending with the date of the PO in IM's ERP." }, "ingramPurchaseOrderDate": { "type": "string", "format": "date", "description": "Ingram Micro's PO date." }, "vendorInvoiceNumber": { "type": "string", "description": "Vendor's invoice number. This field is used for the credit memo number." }, "vendorInvoiceDate": { "type": "string", "format": "date", "description": "This date is also needed for credit memos." }, "InvoiceComments": { "type": "string" }, "vendorOrderNumber": { "type": "string", "description": "Vendor's sales order number." }, "rmaNumber": { "type": "string", "description": "Vendor's RMA number. This is required for credit memos." }, "resellerPurchaseOrderNumber": { "type": "string", "description": "Reseller's PO number." }, "specialBidNumber": { "type": "string", "description": "Used when special pricing is expected - Bid number is required." }, "shipmentDetails": { "type": "object", "required": [ "shipDate", "carrierCode", "carrierName", "carrierBillOfLading", "cartonCount", "weight", "weightUom" ], "description": "Shipping details.", "properties": { "shipDate": { "type": "string", "format": "date", "description": "Date when the product was shipped." }, "carrierCode": { "type": "string", "description": "SCAC code for the carrier" }, "carrierName": { "type": "string", "description": "Carrier name for the shipment including service level." }, "thirdPartyFreightAccountNumber": { "type": "string", "description": "Customers 3rd party freight accountt number if used to ship the project." }, "carrierBillOfLading": { "type": "string", "description": "The carrier's bill of lading or tracking numbers. Needed for all physical product." }, "freightOnBoard": { "type": "string", "description": "Freight on board." }, "cartonCount": { "type": "integer", "description": "The total carton count for the invoice. Needed for all physical product." }, "weight": { "type": "integer", "description": "The total weight for product shipped related to this invoice. Needed for all physical product." }, "weightUom": { "type": "string", "description": "The unit of measure for weight." } } }, "summary": { "type": "object", "required": [ "netAmount", "netDueDays", "netDueDate", "totalTaxAmount", "freightAmount", "discountAmount" ], "properties": { "netAmount": { "type": "integer", "description": "Total amount of the invoice including all tax, freight & fees." }, "netDueDays": { "type": "string", "description": "Days until the invoice payment is due." }, "netDueDate": { "type": "string", "description": "Date until the invoice is due.", "format": "date" }, "totalTaxAmount": { "type": "integer", "description": "Total tax due for the invoice. Must be mapped and tested even if vendor does not plan to send tax." }, "vatTaxAmount": { "type": "integer", "description": "Required if Country Code CA." }, "gstTaxAmount": { "type": "integer", "description": "Required if Country Code CA." }, "hstTaxAmount": { "type": "integer", "description": "Required if Country Code CA." }, "freightAmount": { "type": "integer", "description": "Total Freight Charges due for the invoice. Must be mapped and tested even if vendor does not plan to send freight." }, "discountExpiryDays": { "type": "string", "description": "Days for Ingram Micro to pay the invoice and recover the early pay discount." }, "discountExpiryDate": { "type": "string", "description": "Date for Ingram Micro to pay the invoice and recover the early pay discount.", "format": "date" }, "discountAmount": { "type": "integer", "description": "Early pay discount amount." } } }, "contractInfo": { "type": "object", "properties": { "contractNumber": { "type": "string" }, "contractStartDate": { "type": "string", "format": "date" }, "contractEndDate": { "type": "string", "format": "date" }, "contractComments": { "type": "string" } } }, "invoicingCompanyAddressInfo": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Customer company name." }, "contact": { "type": "string", "description": "Customer contact name." }, "addressLine1": { "type": "string", "description": "Company Name or person to deliver." }, "addressLine2": { "type": "string", "description": "Street address for delivery." }, "addressLine3": { "type": "string", "description": "Continuation of address line 2." }, "city": { "type": "string", "description": "city." }, "state": { "type": "string", "description": "State or Region." }, "postalCode": { "type": "string", "description": "Zip code / Postal code." }, "countryCode": { "type": "string", "description": "Country of delivery." }, "phoneNumber": { "type": "string", "description": "Contact Phone." }, "email": { "type": "string", "description": "Contact Email." } } }, "shipFromInfo": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Company name." }, "contact": { "type": "string", "description": "Contact name" }, "addressLine1": { "type": "string", "description": "Company Name or person to deliver." }, "addressLine2": { "type": "string", "description": "Street address for delivery." }, "addressLine3": { "type": "string", "description": "Continuation of address line 2." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State or Region." }, "postalCode": { "type": "string", "description": "Zip code / Postal code." }, "countryCode": { "type": "string", "description": "Country of delivery." }, "phoneNumber": { "type": "string", "description": "Contact Phone." }, "email": { "type": "string", "description": "Contact Email." } } }, "shipToInfo": { "type": "object", "required": [ "contact", "addressLine1", "city", "state", "postalCode", "countryCode", "phoneNumber", "email" ], "properties": { "companyName": { "type": "string", "description": "Customer company name." }, "contact": { "type": "string", "description": "Customer Contact name." }, "addressLine1": { "type": "string", "description": "Company Name or person to deliver." }, "addressLine2": { "type": "string", "description": "Street address for delivery." }, "addressLine3": { "type": "string", "description": "Continuation of address line 2." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State or Region." }, "postalCode": { "type": "string", "description": "Zip code / Postal code." }, "countryCode": { "type": "string", "description": "Country of delivery." }, "phoneNumber": { "type": "string", "description": "Contact Phone." }, "email": { "type": "string", "description": "Contact Email." } } }, "lines": { "type": "array", "items": { "type": "object", "required": [ "vendorLineNumber", "vendorPartNumber", "partDescription", "ingramLineNumber", "ingramPartNumber", "quantityInvoiced", "unitPrice", "extendedPrice", "licenseKeys" ], "properties": { "vendorLineNumber": { "type": "string", "description": "Vendor's line number." }, "vendorPartNumber": { "type": "string", "description": "Manufacture part number being ordered." }, "partDescription": { "type": "string", "description": "Vendor's description for product." }, "ingramLineNumber": { "type": "string", "description": "Ingram Micro line number." }, "ingramPartNumber": { "type": "string", "description": "Ingram Micro's sku number that is being invoiced." }, "quantityInvoiced": { "type": "integer", "description": "Quantity of product on the invoice or credit memo line." }, "unitPrice": { "type": "integer", "description": "Unit cost is expected to match IM's purchase order cost. Should be sent with 2 decimal places." }, "extendedPrice": { "type": "integer", "description": "Unit cost is expected to match IM's purchase order cost. Should be sent with 2 decimal places." }, "quantityUom": { "type": "string", "description": "Unit of measure. 10 Pack." }, "upcCode": { "type": "string", "description": "UPC code for product." }, "licenseKeys": { "type": "array", "description": "Any combination of license keys.", "items": { "type": "string" } } } } } } }, "InvoiceDetailsError": { "type": "object", "properties": { "errors": { "type": "array", "description": "An array of errors returned by API", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id to identify error." }, "type": { "type": "string", "description": "Describes the type of the error." }, "message": { "type": "string", "description": "Describes the error message." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Contains the name of the field." }, "message": { "type": "string", "description": "Gives the description of the message." }, "value": { "type": "string", "description": "Value sent in the input for the specified field." } } } } } } } } }, "ProactiveRenewalRequest": { "type": "object", "required": [ "referenceId", "timeStamp", "quoteStartDate", "quoteEndDate", "resellerInfo", "endUserInfo", "ingramPurchaseOrderNumber", "ingramPurchaseOrderdate", "lines" ], "properties": { "referenceId": { "type": "string", "description": "Vendor generated unique reference number for this transaction", "example": "1Z3Y2E250313209925" }, "timeStamp": { "type": "string", "format": "date-time", "description": "Vendor request sent datetime", "example": "202104011455" }, "vendorQuoteNumber": { "type": "string", "format": "string", "description": "Vendor generated internal quote number", "example": "Q-1234" }, "quotePrice": { "type": "number", "format": "float", "description": "Total price of the quote", "example": "2500.00" }, "quoteStartDate": { "type": "string", "format": "date", "pattern": "MM/DD/YYYY", "description": "Quote valid from this date", "example": "03/15/2021" }, "quoteEndDate": { "type": "string", "format": "date", "pattern": "MM/DD/YYYY", "description": "Quote valid to this date", "example": "03/15/2022" }, "resellerInfo": { "$ref": "#/components/schemas/ResellerInfo" }, "endUserInfo": { "$ref": "#/components/schemas/EndUserInfo" }, "ingramPurchaseOrderNumber": { "type": "string", "description": "Original Ingram Micro Purchase Order number for renewal", "example": "20-AFT12" }, "ingramPurchaseOrderdate": { "type": "string", "format": "date", "pattern": "MM/DD/YYYY", "description": "Original Ingram Micro Purchase Order date", "example": "03/20/2019" }, "currencyCode": { "type": "string", "enum": [ "USD", "GBP", "CAD", "AUD", "EUR" ], "default": "USD", "description": "currency code to be used, ISO code", "example": "USD" }, "isCoterm": { "type": "boolean", "default": false, "description": "Is this a co-termed contract", "example": false }, "isIncumbent": { "type": "boolean", "default": true, "description": "Is the reseller incumbent overall", "example": true }, "startDate": { "type": "string", "format": "date", "pattern": "MM/DD/YYYY", "description": "Contract start date, if common for all lines", "example": "03/20/2019" }, "endDate": { "type": "string", "format": "date", "pattern": "MM/DD/YYYY", "description": "Contract end date, if common for all lines", "example": "03/20/2019" }, "comments": { "type": "string", "description": "quote level solution comments, these DO appear on the quote", "example": "Attn: ..." }, "instructions": { "type": "string", "description": "quote level instructions for ingram sales associates, these DO NOT appear on the quote", "example": "Attn: ..." }, "additionalAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeNameValue" } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/Line" } } } }, "ResellerInfo": { "type": "object", "required": [ "vendorResellerId", "companyName", "contact", "email" ], "properties": { "vendorResellerId": { "type": "string", "description": "unique id assigned and used by the vendor to identify the reseller, e.g. vendor partner id", "example": "20222222" }, "companyName": { "type": "string", "description": "Reseller company name used by the vendor", "example": "Sunrise And Ronald Solutions" }, "contact": { "type": "string", "description": "Reseller company contact name", "example": "Ronald Roy" }, "email": { "type": "string", "description": "Reseller contact email address", "example": "Sunrise@Ronald.com" }, "addressLine1": { "type": "string", "description": "Reseller postal address line 1", "example": "1081 Merge Point Rd" }, "addressLine2": { "type": "string", "description": "Reseller postal address line 2" }, "addressLine3": { "type": "string", "description": "Reseller postal address line 3" }, "city": { "type": "string", "description": "Reseller postal address city", "example": "Irvine" }, "state": { "type": "string", "description": "Reseller postal address 2 char state", "example": "CA" }, "postalCode": { "type": "string", "description": "Reseller postal address code", "example": "94718" }, "countryCode": { "type": "string", "description": "2 char ISO country code, only countries in the list allowed.", "enum": [ "US", "UK", "DE" ], "default": "US", "example": "US" }, "phoneNumber": { "type": "string", "description": "10 digit phone number of end user contact. No dashes or other characters.", "example": "9495551212" } } }, "EndUserInfo": { "type": "object", "required": [ "vendorEndUserId", "companyName", "contact", "email" ], "properties": { "vendorEndUserId": { "type": "string", "description": "unique id assigned and used by the vendor to identify the end user, e.g. vendor user id", "example": "12345678" }, "companyName": { "type": "string", "description": "end user company name used by the vendor", "example": "Sunrise And Ronald Solutions" }, "contact": { "type": "string", "description": "end user company contact name", "example": "Ronald Roy" }, "email": { "type": "string", "description": "end user contact email address", "example": "Sunrise@Ronald.com" }, "addressLine1": { "type": "string", "description": "end user postal address line 1", "example": "1081 Merge Point Rd" }, "addressLine2": { "type": "string", "description": "end user postal address line 2" }, "addressLine3": { "type": "string", "description": "end user postal address line 3" }, "city": { "type": "string", "description": "end user postal address city", "example": "Irvine" }, "state": { "type": "string", "description": "end user postal address 2 char state", "example": "CA" }, "postalCode": { "type": "string", "description": "end user postal address code", "example": "94718" }, "countryCode": { "type": "string", "description": "2 char ISO country code, only countries in the list allowed.", "enum": [ "US", "UK", "DE" ], "default": "US", "example": "US" }, "phoneNumber": { "type": "string", "description": "10 digit phone number of end user contact. No dashes or other characters.", "example": "9495551212" } } }, "Line": { "type": "object", "required": [ "ingramLineNumber", "renewal", "alternate" ], "properties": { "ingramLineNumber": { "type": "integer", "format": "int32", "description": "serial line number on the quote", "example": 1 }, "isIncumbent": { "type": "boolean", "default": true, "description": "is the partner incumbent for this line", "example": true }, "isAddOn": { "type": "boolean", "default": false, "description": "is line for a new product which did not exist in initial order, upsell", "example": false }, "comments": { "type": "string", "description": "line level solution comments, these DO appear on the quote", "example": "Attn: ..." }, "instructions": { "type": "string", "description": "line level instructions for ingram sales associates, these DO NOT appear on the quote", "example": "Attn: ..." }, "renewal": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOption" } }, "alternate": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOption" } } } }, "ProductInfo": { "required": [ "option", "vendorPartNumber", "quantity", "MSRP" ], "type": "object", "properties": { "vendorPartNumber": { "type": "string", "description": "Vendor part number, VPN/MPN", "example": "VEEAM-PART-1" }, "partDescription": { "type": "string", "description": "Vendor part description", "example": "VEEAM CLOUD CONNECT FOR ENT NEW LICS" }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity", "example": 10 }, "unitPrice": { "type": "number", "format": "float", "description": "Distributor cost / Ingram Micro cost", "example": 1250 }, "MSRP": { "type": "number", "format": "float", "description": "Vendor suggested retail price / manufacturer suggested retail price", "example": 1500 }, "contractLevel": { "type": "string", "description": "Contract level, usually Basic vs Advanced, Basic vs Premium etc.", "example": "Basic" }, "contractType": { "type": "string", "description": "Contract type, usually Annual, perpetual, Annuiity etc.", "example": "Perpetual" }, "startDate": { "type": "string", "format": "date", "pattern": "MM/DD/YYYY", "description": "Contract start date", "example": "03/15/2021" }, "endDate": { "type": "string", "format": "date", "pattern": "MM/DD/YYYY", "description": "Contract end date", "example": "03/14/2021" }, "additionalAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeNameValue" } } } }, "ProductOption": { "type": "object", "required": [ "option", "product" ], "properties": { "option": { "type": "integer", "format": "int32", "description": "first renewal/alternate product option, usually 1 year, 3 year and 5 year, up to 3 allowed. Alternate product is associated with renewal product on an option to option basis", "minimum": 1, "maximum": 3, "example": 1 }, "product": { "$ref": "#/components/schemas/ProductInfo" } } }, "AttributeNameValue": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "specific attributes, not explicitely named but provide more vendor specified info", "example": "licenseNumber" }, "attributeValue": { "type": "string", "description": "value of the specified attribute", "example": "Z2TD-G8CJ-GXW9-EXAE" } } }, "Errors": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Error code", "example": "E01245" }, "type": { "type": "string", "example": "Success" }, "message": { "type": "string", "description": "Error message", "example": "Request contains one or more errors" }, "fields": { "type": "array", "description": "Attributes where the values passed in (or not) had validation errors", "items": { "$ref": "#/components/schemas/FieldError" } } } }, "FieldError": { "type": "object", "required": [ "field", "message" ], "properties": { "field": { "type": "string", "description": "Attribute with errors", "example": "timestamp" }, "value": { "type": "string", "description": "Attribute value passed in", "example": "null" }, "message": { "type": "string", "description": "Error message for the attribute", "example": "timestamp is a required attribute" } } }, "QuoteStatusRequest": { "type": "object", "required": [ "clientId", "referenceId", "transactionId" ], "properties": { "clientId": { "type": "string", "description": "Unique identification number provided to client partner by IM after successful portal registration.", "example": "US326380" }, "referenceId": { "type": "string", "description": "Client unique reference id for this transaction", "example": "veeam_Q-690675_20211014110600" }, "transactionId": { "type": "string", "description": "IM generated unique id for transaction", "example": "C5808E17-C214-4869-99ED-B528C97B68E2" } } }, "GenericResponse": { "type": "object", "required": [ "clientId", "referenceId", "transactionId", "status" ], "properties": { "clientId": { "type": "string", "description": "Unique identification number provided to client partner by IM after successful portal registration.", "example": "US326380" }, "referenceId": { "type": "string", "description": "Client unique reference id for this transaction", "example": "veeam_Q-690675_20211014110600" }, "transactionId": { "type": "string", "description": "IM generated unique id for transaction", "example": "C5808E17-C214-4869-99ED-B528C97B68E2" }, "quoteNumber": { "type": "string", "description": "Generated quote number", "example": "QUO-1033538-R3R6X2" }, "status": { "type": "string", "description": "Quote status", "example": "Pending", "enum": [ "Pending", "Success", "Failure", "Invalid" ] }, "errors": { "type": "array", "description": "If the request has failed, this section will contain detailed error codes and messages", "items": { "$ref": "#/components/schemas/Errors" } } } }, "POCreateWebhook": { "type": "object", "required": [ "topic", "event", "eventtimestamp", "eventid", "resource", "buyerinformation", "lines", "shipmentDetails" ], "properties": { "topic": { "type": "string", "enum": [ "vendors/purchaseorders" ], "description": "The main purpose/action of this notification." }, "event": { "type": "string", "enum": [ "im::vendorpocreate" ], "description": "Indicates the occurrence of a purchase order being created." }, "eventTimeStamp": { "type": "string", "description": "The time the event occurred in HHMMSS.fraction format." }, "eventid": { "type": "string", "description": "Unique identification that corresponds to this event." }, "resource": { "type": "array", "description": "This is the array that contains all the objects and new purchase order information.", "items": { "type": "object", "required": [ "eventType", "ingramPurchaseOrderNumber", "ingramPurchaseOrderDate", "currencyCode", "orderTotal" ], "properties": { "eventType": { "type": "string", "enum": [ "IM::prod" ], "description": "The kind of purchase order being made." }, "ingramPurchaseOrderNumber": { "type": "string", "description": "Ingram Micro's Purchase Order number to the vendor." }, "ingramPurchaseOrderDate": { "type": "string", "format": "date", "description": "Ingram Micro’s purchase order date. The date is in YYYY-MM-DD format to correspond to the date the purchase order was created in Ingram Micro's system." }, "resellerOrderNumber": { "type": "string", "description": "Reseller Order number." }, "orderType": { "type": "string", "description": "The order type." }, "vendorQuoteNumber": { "type": "string", "description": "Reference number for the quote provided from the vendor to the buyer." }, "paymentTerms": { "type": "string", "enum": [ "30" ,"90" ], "example": "30", "description": "The payment terms of the order (ex: 30 days)." }, "currencyCode": { "type": "string", "enum": [ "USD", "AUD", "EUR", "CAD", "GBP" ], "description": "The 3-digit ISO currency code used for the entire order." }, "orderTotal": { "type": "float", "description": "Total order amount/price." }, "notes": { "type": "string", "description": "Order Comments/Notes/Instructions." }, "dpasRating": { "type": "string", "description": "End user government office designation to be used for prioritization and fulfillment purposes. DX rating by Department of Defense is the highest rating/designation, making the order top priority. DO signifies any other gov offices at the US federal government." }, "dpasProgramId": { "type": "string", "description": "Identifies the actual agency that signed off on the DPAS priority." } } } }, "buyerInfo": { "type": "object", "required": [ "billToPartnerId", "companyName", "contact", "addressLine1", "city", "state", "postalCode", "countryCode", "phoneNumber" ], "description": "The address and contact information for the buyer.", "properties": { "billToPartnerId": { "type": "string", "description": "The ID references the partner's address in the vendor's system for billing." }, "buyerName": { "type": "string", "description": "Sales rep contact, contact name of buyer." }, "companyName": { "type": "string", "description": "Company name of the buyer." }, "contact": { "type": "string", "description": "Sales rep contact, contact name of buyer." }, "addressLine1": { "type": "string", "description": "Buyer street address." }, "addressLine2": { "type": "string", "description": "Buyer P.O box, etc." }, "addressLine3": { "type": "string", "description": "Buyer address line 3, any additional address details." }, "city": { "type": "string", "description": "Buyer's city." }, "state": { "type": "string", "description": "The buyer's state." }, "postalCode": { "type": "string", "description": "Contact's zipcode or Postal Code." }, "countryCode": { "type": "string", "enum": [ "US", "AU", "CA" ], "description": "The buyer's two-character ISO country code." }, "phoneNumber": { "type": "string", "description": "The buyer's phone number." }, "email": { "type": "string", "description": "Contact email or generic mailbox." } } }, "resellerInfo": { "type": "object", "required": [ "companyName", "contact", "addressLine1", "city", "state", "postalCode", "countryCode", "email" ], "description": "Object containing reseller address and contact information.", "properties": { "vendorResellerId": { "type": "string", "description": "The vendor reseller's Id." }, "companyName": { "type": "string", "description": "The reseller's company name." }, "contact": { "type": "string", "description": "The reseller's contact name." }, "addressLine1": { "type": "string", "description": "The reseller's street address." }, "addressLine2": { "type": "string", "description": "Reseller's P.O.box, Building Number, etc." }, "addressLine3": { "type": "string", "description": "Additional reseller address information on line 3." }, "city": { "type": "string", "description": "The reseller's city." }, "state": { "type": "string", "description": "The reseller's state." }, "postalCode": { "type": "string", "description": "The reseller's zip or postal code." }, "countrycode": { "type": "string", "enum": [ "US", "AU", "CA" ], "description": "The reseller's two-character ISO country code. " }, "phoneNumber": { "type": "string", "description": "Reseller's contact phone number." }, "email": { "type": "string", "description": "Reseller's contact email address." } } }, "endUserInfo": { "type": "object", "required": [ "companyName", "contact", "addressLine1", "email" ], "description": "This is the object containing end user contact and address information. The end user is the customer receiving the final product from the reseller/vendor.", "properties": { "vendorEndUserId": { "type": "string", "description": "The ID that references the end user/customer's address information in the vendor's system." }, "companyName": { "type": "string", "description": "End user company name." }, "contact": { "type": "string", "description": "End user contact name." }, "addressLine1": { "type": "string", "description": "End user street address." }, "addressLine2": { "type": "string", "description": "End user building, PO box, or apt number." }, "addressLine3": { "type": "string", "description": "Additional address information on line 3." }, "city": { "type": "string", "description": "The end user/customer's city." }, "state": { "type": "string", "description": "The end user/customer's state." }, "postalCode": { "type": "string", "description": "The end user/customer's zip or postal code." }, "countryCode": { "type": "string", "enum": [ "US", "AU", "CA" ], "description": "End user’s two-character ISO country code." }, "phoneNumber": { "type": "string", "description": "The end user/customer's phone number." }, "email": { "type": "string", "description": "The end user/customer's email." } } }, "lines": { "type": "array", "description": "Object containing line item information such as vendor part information, prices, contract information, etc.", "items": { "type": "object", "required": [ "ingramLineNumber", "vendorPartNumber", "vendorPartDescription", "ingramPartNumber", "quantity", "unitPrice", "itemTotal" ], "properties": { "ingramLineNumber": { "type": "string", "description": "Unique Ingram line number for each line supplied on PO, starts with 001." }, "vendorLineNumber": { "type": "string", "description": "Vendor assigned line/quote number." }, "vendorPartNumber": { "type": "string", "description": "The vendor part number for the line item." }, "vendorPartDescription": { "type": "string", "description": "The vendor's description of the part in their system." }, "ingramPartNumber": { "type": "string", "description": "Unique Ingram Micro's part number for the vendor." }, "quantity": { "type": "number", "format": "float", "description": "The number of line items being ordered." }, "quantityUom": { "type": "string", "enum": [ "EA", "QT" ], "description": "Ingram Micro's agreed unit price of the line item." }, "unitPrice": { "type": "number", "format": "float", "description": "Ingram Micro's agreed unit price of the line item." }, "vendorNumber": { "type": "string", "description": "Ingram Micro's code number associated to this vendor." }, "UPCcode": { "type": "string", "description": "The UPC code for the line item. Consists of 12 numeric digits that are uniquely assigned to each trade item." }, "unit": { "type": "number", "format": "float", "description": "The number of units for ordered for this particular item." }, "itemTotal": { "type": "number", "format": "float", "description": "Total price of this item times the quantity ordered." }, "specialBidNumber": { "type": "string", "description": "The line-level bid number provided to the reseller by the vendor for special pricing and discounts. Used to track the bid number where different line items have different bid numbers. Line-level bid numbers take precedence over header-level bid numbers." }, "secondaryBidNumber": { "type": "string", "description": "Vendor defined secondary bid number provided by customer." }, "serialNumbers": { "type": "array", "description": "An array of objects containing serial numbers of the line items contained in the shipment.", "items": { "type": "object", "properties": { "serialNumber": { "type": "string", "description": "The serial number of the original SKU that is being renewed or being supported." } } } }, "lineNotes": { "type": "array", "description": "An array of objects containing Additional line notes/comments.", "items": { "type": "object", "properties": { "lineNote": { "type": "string", "description": "Additional line notes/comments." } } } }, "hardwareId": { "type": "string", "description": "ID used for associating hardware with warranty." }, "serviceContract": { "type": "string", "description": "Service contract details for the line item." }, "contractNumber": { "type": "string", "description": "Contract number for the service." }, "contractStartDate": { "type": "string", "format": "date", "description": "Contract start date in YYYY-MM-DD date format." }, "contractEndDate": { "type": "string", "format": "date", "description": "Contract end date in YYYY-MM-DD date format." }, "contractDuration": { "type": "string", "description": "Duration of the contract in in months." }, "endUserInfo": { "type": "array", "description": "Object within the lines object that provides the contact and address information of the end user receiving the order.", "items": { "type": "object", "required": [ "endUserCompanyName", "endUserContactName", "endUserEmail" ], "properties": { "endUserCompanyName": { "type": "string", "description": "End user company name." }, "endUserContactName": { "type": "string", "description": "End user contact name." }, "endUserPhoneNumber": { "type": "string", "description": "End user phone number." }, "endUserEmail": { "type": "string", "description": "End user email information." } } } } } } }, "shipmentDetails": { "type": "object", "required": [ "carrierCode", "shipToInfo" ], "description": "Object containing shipping/package details related to this purchase order.", "properties": { "carrierCode": { "type": "string", "description": "Specific carrier code provided by the customer." }, "carrierService": { "type": "string", "enum": ["FedEX Overnight", "UPSN"], "description": "The type of delivery service for the designated shipment." }, "fobTerms": { "type": "string", "description": "FOB terms consist of the destination or origin of the order, and ownership and risk information during shipping." }, "fobPaymentTerms": { "type": "string", "description": "The FOB payment terms includes information about who pays for freight. This payment can be either Ingram, Customer or the Vendor." }, "frieghtAccountNumber": { "type": "string", "description": "Customer provided freight account number. The freight account number is used to bill the shipping carrier directly from the reseller's account with the carrier." }, "requestedDeliveryDate": { "type": "string", "format": "date", "description": "The requested delivery date of the shipment, if this date is provided, then the customer is NOT expecting the delivery prior to this date. The requested delivery date is in YYYY-MM-DD date format. Delivery date is not guaranteed." }, "shipmentDate": { "type": "string", "format": "date", "description": "The shipment date considered as promise date." }, "shipComplete": { "type": "boolean", "description": "Specifies whether the shipment will be shipped only when all products are fulfilled. Default is No." }, "shippingInstructions": { "type": "array", "description": "An array of objects containing shipping instructions.", "items": { "type": "object", "properties": { "shippingInstruction": { "type": "string", "description": "Notes or instructions given to carriers used for delivering this order. Contains additional shipping information for carriers to complete the order as specified." } } } }, "shipToInfo": { "type": "object", "required": [ "companyName", "addressLine1", "city", "state", "postalCode", "countryCode" ], "description": "Object containing shipping address for this order.", "properties": { "contact": { "type": "string", "description": "Ship to / attention name." }, "companyName": { "type": "string", "description": "Ship to company name." }, "addressLine1": { "type": "string", "description": "Street Address that order will be shipped to." }, "addressLine2": { "type": "string", "description": "Ship to building, PO box, apt number that the order will be delivered to." }, "addressLine3": { "type": "string", "description": "Ship to additional address details." }, "city": { "type": "string", "description": "Ship to city that the order will be delivered to." }, "state": { "type": "string", "description": "Ship to state that the order will be delivered to." }, "postalCode": { "type": "string", "description": "Ship to Postal or zipcode that the order will be delivered to." }, "countryCode": { "type": "string", "enum": [ "US", "AU", "CA" ], "description": "2-character ISO country code." }, "phoneNumber": { "type": "string", "description": "Ship to phone number." }, "email": { "type": "string", "description": "Ship to contact email address." } } } } } } } }, "securitySchemes": { "application": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://api.ingrammicro.com:443/oauth/oauth30/token", "scopes": { "write": "allows modifying resources", "read": "allows reading resources" } } }, "description": "" } } } }