{ "openapi" : "3.0.0", "info" : { "version" : "6.0", "title" : "Reseller API Documentation - United States", "description" : "For Resellers.
\nWho are looking to Innovate with Ingram Micro's API SolutionsAutomate your eCommerce with our offering of APIs and Webhooks to create a seamless experience for your customers." }, "tags" : [ { "name": "Subscription Management", "description": "\nIngram Micro's Subscription Management v7 API endpoints enable resellers to monitor and manage the full lifecycle of cloud subscriptions across their customer base. Using these endpoints, resellers can:\n - Search and filter all active and historical subscriptions across customer accounts by status, expiry date, customer, or order reference.\n - View complete subscription details including plan, billing period, renewal dates, pricing, revenue metrics, and available operations.\n - Identify subscriptions nearing expiration or upcoming auto-renewals to act proactively.\n - Access subscription order history and end-customer information for reporting and account management.\n - Perform lifecycle operations such as upsizing, upgrades, co-terms, and cancellations (Coming soon)." },{ "name" : "Product Catalog", "description" : "\nThe Ingram Micro Product Catalog v6 API endpoints enable users to:\n - Search products by SKU or additional criteria.\n - Find price and availability for up to 50 SKUs at one time.\n - View inventory by location in the product catalog.\n \n *Host Production URL - https://api.ingrammicro.com:443/resellers/v6*\n " }, { "name" : "Orders", "description" : "\nIngram Micro’s Orders v6 API endpoints support both standard products and direct-ship products, including licensing and warranties SKUs. Users can:\n - Search existing orders by Ingram Micro sales order number.\n - View order details.\n - Create and place new orders.\n - Cancel orders, as permitted by order status.\n \n*Host Production URL - https://api.ingrammicro.com:443/resellers/v6*\n " }, { "name" : "Quotes", "description" : "\nThis endpoint enables the retrieval and filtering of relevant quote list key criteria data, such as quote number, special bid numbers, end user name, status, and date ranges from the Ingram Micro system. By default, the Quotes endpoint retrieves quotes modified or created within the last 30 days.\nObserve these additional parameters:\n - Only active quotes are available through this API.\n - Quotes older than 365 days are excluded by default.\n - You can use date range filters to retrieve quotes older than 30 days and up to 365 days.\n - Quotes that are in draft and closed states are excluded, and are not accessible through this API.\n \n*Host Production URL - https://api.ingrammicro.com:443/resellers/v6* " }, { "name" : "Invoices", "description" : "\nThe Ingram Micro Invoice v6 API endpoint provide real-time information for invoices. Users can:\n - Get invoice information.\n - View invoice information is available for orders placed in the last 2 years, by providing an Invoice number.\n\n\n*Host Production URL - https://api.ingrammicro.com:443/resellers/v6*\n" }, { "name" : "OrderStatus", "description" : "\nA customer/reseller can select one or all of the events listed above under one webhook or can create individual webhook for each event. The primary reason to create multiple webhooks would be to have a dedicated destination URL for each event for processing. It is not required to do so and is recommended to have a single webhook for a resource type, for example a webhook for orders and in future you may have a dedicated webhook for quotes.\n\n\n*Host Production URL - https://api.ingrammicro.com:443/resellers/v1* \n" }, { "name" : "StockUpdate", "description" : "\nA customer/reseller can select this event to get the updated quantity of the IPN. This event will trigger the updated quantity with a particular interval. To get the information of any SKU/IPN the customer should be authorized.\n\n\n*Host Production URL - https://api.ingrammicro.com:443/resellers/v1* \n" },{ "name" : "QuoteCreate", "description" : "\nA customer/reseller can select this event to get the updates related to quote creation process. This event will trigger the for all the quotes created via the Xvantage platform, APIs, associates, etc." },{ "name" : "Renewals", "description" : " " }, { "name" : "Deals", "description" : " " }, { "name" : "Returns", "description" : " " }, { "name":"Freight Estimate", "description":" " }, { "name" : "Orders v5", "description" : "\nIngram Micro’s Orders v5 API endpoints support both standard products and direct-ship products, including licensing and warranties SKUs. Users can:\n - Search existing orders by Ingram Micro sales order number.\n - View order details.\n - Create and place new orders.\n - Cancel orders, as permitted by order status.\n\n\n*Host Production URL - https://api.ingrammicro.com:443/resellers/v5*\n" }, { "name" : "Product Catalog v5", "description" : "\nThe Ingram Micro Product Catalog v6 API endpoints enable users to:\n - Search products by SKU or additional criteria.\n - Find price and availability for up to 50 SKUs at one time.\n - View inventory by location in the product catalog.\n\n\n*Host Production URL - https://api.ingrammicro.com:443/resellers/v5*\n" }, { "name" : "Quotes v5", "description" : "\nThe Ingram Micro Quotes v5 API endpoints enable users to:\n - Obtain a list of all quotes.\n - View details for each quote, including: quote name, quote number, expiration date, product quantity and product price.\n - Ingram Micro does not currently offer an API to create a quote.\n\n\n*Host Production URL - https://api.ingrammicro.com:443/resellers/v5*\n" }, { "name" : "Invoices V5", "description" : "\nThe Ingram Micro Invoice v5 API endpoint provide real-time information for invoices and corresponding orders. Users can:\n - Get invoice information for an open order or shipped order.\n - View invoice information is available for orders placed in the last 9 months, by providing a sales order number.\n\n\n*Host Production URL - https://api.ingrammicro.com:443/resellers/v5*\n" } ], "x-tagGroups" : [ { "name" : "Reseller API (Version 7)", "tags" : [ "Orders v7","Invoices v7", "Subscription Management"] },{ "name" : "Reseller API (Version 6)", "tags" : [ "Product Catalog", "Orders", "Quotes", "Invoices", "Renewals", "Deals", "Returns", "Freight Estimate"] }, { "name" : "Webhook APIs (Version 6)", "tags" : [ "OrderStatus", "StockUpdate","QuoteCreate" ] }, { "name" : "Legacy APIs (Version 6)", "tags" : [ "Orders v6", "Invoices v6" ] }, { "name" : "Legacy APIs (Version 5)", "tags" : [ "Product Catalog v5", "Orders v5", "Quotes v5", "Invoices V5" ] }], "paths" : { "/resellers/v7/subscriptions/search": { "get": { "summary": "Subscription Search/List", "tags": [ "Subscription Management" ], "description": "The Subscriptions List/Search API enables resellers to retrieve all active and historical subscriptions associated with their customer accounts. This endpoint serves as the foundation for subscription lifecycle management, allowing you to:

**Key Features:**

Supports filtering, pagination, and summary insights for efficient data retrieval.

", "operationId": "get-subscription_search_list", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "IM-CustomerNumber", "in": "header", "description": "Your unique Ingram Micro customer number.", "required": true, "schema": { "type": "string", "maxLength": 10, "example": "20-222222" } }, { "name": "IM-CountryCode", "in": "header", "description": "Two-character ISO country code.", "required": true, "schema": { "type": "string", "maxLength": 2, "minLength": 2, "example": "US" } }, { "name": "IM-SenderID", "in": "header", "description": "Unique value used to identify the sender of the transaction. Example: MyCompany", "required": false, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": true, "schema": { "type": "string", "maxLength": 32, "example": "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name": "pageNumber", "in": "query", "description": "Current page number. Default is 1", "required": false, "schema": { "type": "integer" } }, { "name": "pageSize", "in": "query", "description": "Number of records required in the call. Default is 5", "required": false, "schema": { "type": "integer" } }, { "name": "subscriptionId", "in": "query", "description": "Filter by a specific subscription ID", "required": false, "schema": { "type": "integer" } }, { "name": "endCustomer", "in": "query", "description": "Filter by end customer name", "required": false, "schema": { "type": "string" } }, { "name": "endCustomerId", "in": "query", "description": "Filter by unique end customer ID", "required": false, "schema": { "type": "integer" } }, { "name": "customerOrderNumber", "in": "query", "description": "Filter by customer order number", "required": false, "schema": { "type": "string" } }, { "name": "agreementId", "in": "query", "description": "Filter by agreement ID", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by subscription status Enum: ", "required": false, "schema": { "type": "string", "enum" : [ "ACTIVE", "PENDING", "GRACED", "EXPIRED","TERMINATED","CANCELLED","ADMINHOLD","CREDITHOLD","FULLHOLD","TRIAL" ] } }, { "name": "paymentTermsCode", "in": "query", "description": "Filter by TermsCode", "required": false, "schema": { "type": "string" } }, { "name": "expiringWithinDays", "in": "query", "description": "Return subscriptions expiring within X days. Values: 7, 30", "required": false, "schema": { "type": "integer" } }, { "name": "autoRenewWithinDays", "in": "query", "description": "Return subscriptions auto-renewing within X days. Value: 30", "required": false, "schema": { "type": "integer" } } ], "responses" : { "200": { "description": "Success", "headers": { "IM-CorrelationID": { "required": true, "schema": { "type": "string" }, "description": "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID": { "required": true, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" }, "description": "Sender Identification text." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscrption_list_response" }, "examples": { "Sample Response": { "value": { "pageSize": 1, "pageNumber": 2, "subscriptionsSummary": { "total": 8, "active": 2, "pending": 0, "trial": 0, "expiringWithin7Days": 0, "expiringWithin30Days": 0, "autoRenewWithin30Days": 0 }, "subscriptions": [ { "planName": "Cisco Cloud", "quantity": 30, "measureUnit": "Licenses", "endCustomer": "ABC TECHNOLOGIES", "endCustomerId": "1299100207", "isAutoRenew": false, "isTrial": false, "subscriptionPeriod": 1, "subscriptionPeriodUnit": "MONTHS", "billingPeriod": 1, "billingPeriodUnit": "MONTHS", "subscriptionStartDate": "2022-11-11T00:00:00", "subscriptionEndDate": "2022-12-11T00:00:00", "subscriptionId": "5031097", "customerOrderNumber": "MyPONumber", "status": "ACTIVE", "links": { "topic": "details", "href": "resellers/v7/subscriptions/b2b/detail/5031097", "type": "GET" } } ], "nextPage": "/resellers/v7/subscriptions/search?[original_parameters]&Page=3", "previousPage": "/resellers/v7/subscriptions/search?[original_parameters]&Size=5&Page=1" } } } } } } } } }, "/resellers/v7/subscriptions/{subscriptionId}": { "get": { "summary": "Subscriptions Details", "tags": [ "Subscription Management" ], "description": "

The Subscription Details API allows customers to retrieve detailed information for a single subscription using the Ingram Micro subscription ID as a path parameter. The endpoint returns subscription status, plan and billing details, renewal information, pricing and revenue metrics, subscribed resources, subscription order history, and end-customer information.

This endpoint enables customers to fully understand the attributes and state of each subscription before taking actions such as upgrades, cancellations, or plan comparisons.

", "operationId": "get-subscription_details", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Unique identifier for the subscription to retrieve", "required": true, "schema": { "type": "string", "example": "2047420" } }, { "name": "includeOperations", "in": "query", "description": "If true, the response will contain the available operations for the subscription.", "required": false, "schema": { "type": "boolean" } }, { "name": "IM-CustomerNumber", "in": "header", "description": "Your unique Ingram Micro customer number.", "required": false, "schema": { "type": "string", "maxLength": 10, "example": "20-222222" } }, { "name": "IM-CountryCode", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": true, "schema": { "type": "string", "maxLength": 2, "example": "US" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": false, "schema": { "type": "string", "example": "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name": "IM-SenderID", "in": "header", "description": "Unique value used to identify the sender of the transaction.", "required": false, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" } } ], "responses": { "200": { "description": "OK", "headers": { "IM-CorrelationID": { "required": true, "schema": { "type": "string" }, "description": "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID": { "required": true, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" }, "description": "Sender Identification text." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscrption_details_response" }, "examples": { "Sample Response": { "value": { "subscriptionId": "2146733", "planId": "805700", "planName": "Microsoft 365 F1 (NCE COM MTH)", "status": "ACTIVE", "isAutoRenew": true, "customerOrderNumber": "MYPONUMBER", "endCustomerName": "ABC TECHNOLOGIES", "subscriptionPeriod": 1, "subscriptionPeriodUnit": "MONTHS", "billingPeriod": 1, "billingPeriodUnit": "MONTHS", "startDate": "2024-06-12", "endDate": "2026-02-12", "nextBillingDate": "2026-02-12", "renewalDate": "2026-02-11", "lastDayForChanges": "2026-02-10", "allowedOperations": { "changeAllowed": true, "partialUpgrade": false, "coTerm": false, "enableAutoRenew": true, "disableAutoRenew": false, "putOnHold": true, "cancel": false }, "paymentTermsCode": "300", "revenueMetrics": { "profit": 59.52, "revenuePerYear": 67.52, "margin": 88.15, "costPerYear": 8.00, "currencyCode": "USD" }, "resources": [ { "resourceName": "Microsoft 365 F1", "vendorPartNumber": "CFQ7TTC0MBMD:0002", "quantity": 4.00, "unitOfMeasure": "Licenses", "unitCost": 2.00, "unitPrice": 16.88, "margin": 88.15, "currencyCode": "USD" } ], "subscriptionsHistory": [ { "createdOn": "2024-07-12", "status": "Completed", "orderType": "Billing Order", "ingramOrderNumber": "BO008645", "orderId": "117889538", "orderTotal": 2.51, "currencyCode": "USD" }, { "createdOn": "2024-07-10", "status": "Completed", "orderType": "Renewal Order", "ingramOrderNumber": "RN008407", "orderId": "117754062", "orderTotal": 0, "currencyCode": "USD" }, { "createdOn": "2024-04-28", "status": "Completed", "orderType": "Sales Order", "ingramOrderNumber": "SO004178", "orderId": "113225885", "orderTotal": 2.51, "currencyCode": "USD" } ], "endCustomerDetails": { "companyName": "ABC TECHNOLOGIES", "accountID": "1000482238", "taxId": "ESB12345678", "resellerAccountId": "1000052", "administrativeContact": { "contactPerson": "Alex Johnson", "email": "alex.johnson@example.com", "phone": "+ 800-4578000" }, "billingContact": { "contactPerson": "Maria Lopez", "email": "maria.lopez@example.com", "phone": "+ 800-4578001" }, "technicalContact": { "contactPerson": "Chris Miller", "email": "chris.miller@example.com", "phone": "+ 800-4578002" } } } } } } } } } } }, "/resellers/v7/subscriptions/plan/{subscriptionId}": { "get": { "summary": "Get Plan Details API", "tags": [ "Subscription Management" ], "description": "

The Get Plan Details API retrieves all available and related plan options for a specific subscription. This API enables customers to view upgrade paths, partial upgrade options, and co-term alignment possibilities for subscription management.

\n\n| Operation | Uses API Response | Description |\n|-----------|------------------|-------------|\n| Upsize / Downsize | currentSubscription | Retrieve current planId, resourceId, and policy flags to confirm whether upsizing or downsizing is permitted for the subscription period. |\n| Upgrade | upgrade[] | Identify available higher-tier plans. Use resourceMapping.targetResourceId as the targetResourceId in the Estimate and Change Order request. |\n| Partial Upgrade | partialUpgrade[] | Identify plans available for partial license migration. Use resourceMapping.targetResourceId to specify the target resource for the subset of licenses being moved. |\n| Co-term | cotermOptions | Retrieve available alignmentTypes (e.g. MATCH_END_OF_CALENDAR_MONTH, CO_TERM_ON_SUBSCRIPTION) and eligible cotermSubscriptions for date alignment operations. | \n\n ## Resource Mapping **Note:** The 'resourceMapping' object within 'upgrade' and partialUpgrade' responses is returned only for Microsoft and Dropbox subscriptions. ", "operationId": "get-plan-details-API", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Unique identifier of the subscription", "required": true, "schema": { "type": "string" } }, { "name": "IM-CustomerNumber", "in": "header", "description": "Your unique Ingram Micro customer number.", "required": false, "schema": { "type": "string", "maxLength": 10, "example": "20-222222" } }, { "name": "IM-CountryCode", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": true, "schema": { "type": "string", "maxLength": 2, "example": "US" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": false, "schema": { "type": "string", "example": "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name": "IM-SenderID", "in": "header", "description": "Unique value used to identify the sender of the transaction.", "required": false, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" } } ], "responses": { "200": { "description": "OK", "headers": { "IM-CorrelationID": { "required": true, "schema": { "type": "string" }, "description": "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID": { "required": true, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" }, "description": "Sender Identification text." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan_details_api_response" }, "examples": { "Sample Response": { "value": { "currentSubscription": { "planId": "657739", "planName": "Microsoft 365 Business Basic (NCE COM MTH)", "description": "Best for businesses that need professional email, cloud file storage, and online meetings & chat. Desktop versions of Office apps like Excel, Word, and PowerPoint not included. For businesses with up to 300 employees.", "billingPeriod": { "unit": "MONTHS", "period": 1 }, "subscriptionPeriod": [ { "unit": "MONTHS", "period": 1, "policy": { "immediateSwitchAllowed": true, "downSizeAllowed": true, "upsizeAllowed": true } } ], "resources": [ { "resourceId": "1018516", "resourceUId": "f76cd776-0657-4293-bdf6-ddb305f76422", "resourceName": "Microsoft", "vendorPartNumber": "CFQ7TTC0LH18:0001", "minUnits": 1, "maxUnits": 300, "unitOfMeasure": "Licenses" } ] }, "upgrade": [ { "planId": "438321", "planName": "Office 365 E5 without Audio Conferencing (NCE COM MTH)", "description": "The Office suite for PC and Mac, plus email, instant messaging, HD video conferencing, 1 TB personal file storage and sharing, analytics, and advanced security. Does not include Audio conferencing.", "billingPeriod": { "unit": "MONTHS", "period": 1 }, "subscriptionPeriod": [ { "unit": "YEARS", "period": 1, "policy": { "immediateSwitchAllowed": true, "downSizeAllowed": true, "upsizeAllowed": true } } ], "resources": [ { "resourceId": "1018539", "resourceUId": "690f6cf4-ae00-4c50-89ae-a34e603da80e", "resourceName": "Microsoft", "vendorPartNumber": "CFQ7TTC0LF8S:0001", "minUnits": 1, "maxUnits": 5000, "unitOfMeasure": "Licenses", "resourceMapping": { "fromResourceId": "1018516", "targetResourceId": "1018539" } } ] } ], "partialUpgrade": [ { "planId": "657739", "planName": "Microsoft 365 Business Basic (NCE COM MTH)", "description": "Best for businesses that need professional email, cloud file storage, and online meetings & chat. Desktop versions of Office apps like Excel, Word, and PowerPoint not included. For businesses with up to 300 employees.", "billingPeriod": { "unit": "MONTHS", "period": 1 }, "subscriptionPeriod": [ { "unit": "YEARS", "period": 1, "policy": { "immediateSwitchAllowed": true, "downSizeAllowed": true, "upsizeAllowed": true } } ], "resources": [ { "resourceId": "1018516", "resourceUId": "f76cd776-0657-4293-bdf6-ddb305f76422", "resourceName": "Microsoft", "vendorPartNumber": "CFQ7TTC0LH18:0001", "minUnits": 1, "maxUnits": 300, "unitOfMeasure": "Licenses" } ] } ], "cotermOptions": { "alignmentTypes": [ "SAME_AS_PREVIOUS", "CO_TERM_ON_SUBSCRIPTION", "MATCH_END_OF_CALENDAR_MONTH" ], "cotermSubscriptions": [ { "subscriptionId": "2330456", "name": "Exchange Online (Plan 2) (NCE COM ANN)", "expirationDate": "2026-12-04" } ] } } } } } } } } } }, "/resellers/v7/subscriptions/estimate": { "post": { "summary": "Estimate API", "tags": [ "Subscription Management" ], "description": "

The Estimate Order API enables customers and internal systems to programmatically compute detailed pricing and cost calculations for multiple order types before actually placing an order. The estimate response will include taxes, discounts, promotions, and resource-based charges, the API ensures pricing outputs align with production order-processing logic.

", "operationId": "post-estimate-api", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "IM-CustomerNumber", "in": "header", "description": "Your unique Ingram Micro customer number.", "required": false, "schema": { "type": "string", "maxLength": 10, "example": "20-222222" } }, { "name": "IM-CountryCode", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": true, "schema": { "type": "string", "maxLength": 2, "example": "US" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": false, "schema": { "type": "string", "example": "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name": "IM-SenderID", "in": "header", "description": "Unique value used to identify the sender of the transaction.", "required": false, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" } } ], "requestBody": { "content": { "application/json": { "examples" : { "Upsize Operation": { "value" : { "subscriptionId": "2176793", "planId": "805700", "resources": [ { "resourceId": "1018527", "quantity": 5 } ] } }, "Upgrade Operation": { "value" : { "subscriptionPeriod": { "unit": "MONTHS", "period": 1 }, "planId": "796290", "resources": [ { "quantity": 4, "resourceId": "1018527", "targetResourceId": "1031236" } ], "subscriptionId": "2176793" } }, "Partial Upgrade Operation": { "value" : { "subscriptionPeriod": { "unit": "MONTHS", "period": 1 }, "planId": "796299", "alignmentType": "CO_TERM_PARTIAL_UPGRADE", "coTermSubscriptionId": "", "resources": [ { "quantity": 1, "resourceId": "1018527", "targetResourceId": "1031229" } ], "subscriptionId": "2176793" } }, "Immediate Co-term": { "value" : { "subscriptionPeriod": { "unit": "MONTHS", "period": 1 }, "planId": "805700", "alignmentType": "SAME_AS_PREVIOUS", "coTermSubscriptionId": "", "resources": [ { "quantity": 4, "resourceId": "1018527", "targetResourceId": "" } ], "subscriptionId": "2176793" } }, "Co-term Match End Of Calendar Month": { "value" : { "subscriptionPeriod": { "unit": "MONTHS", "period": 1 }, "planId": "805700", "alignmentType": "MATCH_END_OF_CALENDAR_MONTH", "coTermSubscriptionId": "", "resources": [ { "quantity": 5, "resourceId": "1018527", "targetResourceId": "" } ], "subscriptionId": "2176793" } }, "Co-term on Subscription": { "value" : { "subscriptionPeriod": { "unit": "YEARS", "period": 1 }, "planId": "657739", "coTermSubscriptionId": "2330456", "resources": [ { "quantity": 33, "resourceId": "1018516", "targetResourceId": "" } ], "subscriptionId": "1875230" } } }, "schema": { "$ref": "#/components/schemas/estimated_api_request" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "IM-CorrelationID": { "required": true, "schema": { "type": "string" }, "description": "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID": { "required": true, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" }, "description": "Sender Identification text." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/estimate_plan_response" }, "examples": { "Sample Response": { "value": {"subscriptionId": "2176793", "planId": "805700", "planName": "Microsoft 365 Business Standard", "summary": { "isDualCurrency": true, "customerCurrency": "MXN", "vendorCurrency": "USD", "customer": { "taxAmount": 0.0, "discount": 0, "totalCost": 1.29, "taxAmountVendorCurrency": 0.0, "totalCostVendorCurrency": 3.29 }, "endCustomer": { "taxAmount": 0.0, "discount": 0, "totalPrice": 10.89, "taxAmountVendorCurrency": 0.0, "totalPriceVendorCurrency": 3.29 } }, "resources": [ { "resourceId": "1018527", "resourceName": "Microsoft 365 Business Standard", "vendorPartNumber": "CFQ7TTC0LFLZ:0001", "quantity": 5, "unitOfMeasure": "Licenses", "pricing": { "customer": { "unitCost": 2.0, "setupCost": 0, "discount": 0, "taxAmount": 0.0, "totalCost": 1.29, "taxAmountVendorCurrency": 0.0, "totalCostVendorCurrency": 3.29 }, "endCustomer": { "unitPrice": 16.88, "setupPrice": 0, "discount": 0, "taxAmount": 0.0, "totalPrice": 10.89, "taxAmountVendorCurrency": 0.0, "totalPriceVendorCurrency": 3.29 } } } ] } } } } } } } } }, "/resellers/v7/subscriptions/modify": { "post": { "summary": "Subscription Order Change", "tags": [ "Subscription Management" ], "description": "

The Subscription Order Change API enables resellers to submit subscription modification requests to the Ingram Micro Xvantage (XVS) platform. This is the execution endpoint in the subscription lifecycle — once a reseller has identified the operation to perform using the companion APIs, this endpoint submits the order change for asynchronous processing.

The API is asynchronous: a synchronous validation response is returned immediately upon submission, followed by an asynchronous webhook notification once the order has been fully processed by the XVS systems.

", "operationId": "post-subscription-order-change", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "IM-CustomerNumber", "in": "header", "description": "Your unique Ingram Micro customer number.", "required": true, "schema": { "type": "string", "maxLength": 10, "example": "20-222222" } }, { "name": "IM-CountryCode", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": true, "schema": { "type": "string", "maxLength": 2, "example": "US" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": true, "schema": { "type": "string", "example": "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name": "IM-SenderID", "in": "header", "description": "Unique value used to identify the sender of the transaction.", "required": false, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" } } ], "requestBody" : { "content" : { "application/json" : { "examples" : {"subscriptionId": "2187580", "orderType": "CHANGE", "subscriptionPeriod": { "type": "YEARS", "duration": 1 }, "planId": "924513", "resources": [ { "quantity": 3, "resourceId": "1015762" } ], "additionalAttributes": [ { "attributeName": "PONumber", "attributeValue": "MYPO-2026-001" } ]}, "schema" : { "$ref" : "#/components/schemas/subscription_change_request" } } }, "required" : true }, "responses": { "200": { "description": "OK", "headers": { "IM-CorrelationID": { "required": true, "schema": { "type": "string" }, "description": "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID": { "required": true, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" }, "description": "Sender Identification text." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription_change_response" }, "examples": { "Sample Response": { "value": { "subscriptionId": "2146733", "planId": "805700", "planName": "Microsoft 365 F1 (NCE COM MTH)", "status": "ACTIVE", "isAutoRenew": true, "customerOrderNumber": "MYPONUMBER", "endCustomerName": "ABC TECHNOLOGIES", "subscriptionPeriod": 1, "subscriptionPeriodUnit": "MONTHS", "billingPeriod": 1, "billingPeriodUnit": "MONTHS", "startDate": "2024-06-12", "endDate": "2026-02-12", "nextBillingDate": "2026-02-12", "renewalDate": "2026-02-11", "lastDayForChanges": "2026-02-10", "allowedOperations": { "changeAllowed": true, "partialUpgrade": false, "coTerm": false, "enableAutoRenew": true, "disableAutoRenew": false, "putOnHold": true, "cancel": false }, "paymentTermsCode": "300", "revenueMetrics": { "profit": 59.52, "revenuePerYear": 67.52, "margin": 88.15, "costPerYear": 8.00, "currencyCode": "USD" }, "resources": [ { "resourceName": "Microsoft 365 F1", "vendorPartNumber": "CFQ7TTC0MBMD:0002", "quantity": 4.00, "unitOfMeasure": "Licenses", "unitCost": 2.00, "unitPrice": 16.88, "margin": 88.15, "currencyCode": "USD" } ], "subscriptionsHistory": [ { "createdOn": "2024-07-12", "status": "Completed", "orderType": "Billing Order", "ingramOrderNumber": "BO008645", "orderId": "117889538", "orderTotal": 2.51, "currencyCode": "USD" }, { "createdOn": "2024-07-10", "status": "Completed", "orderType": "Renewal Order", "ingramOrderNumber": "RN008407", "orderId": "117754062", "orderTotal": 0, "currencyCode": "USD" }, { "createdOn": "2024-04-28", "status": "Completed", "orderType": "Sales Order", "ingramOrderNumber": "SO004178", "orderId": "113225885", "orderTotal": 2.51, "currencyCode": "USD" } ], "endCustomerDetails": { "companyName": "ABC TECHNOLOGIES", "accountID": "1000482238", "taxId": "ESB12345678", "resellerAccountId": "1000052", "administrativeContact": { "contactPerson": "Alex Johnson", "email": "alex.johnson@example.com", "phone": "+ 800-4578000" }, "billingContact": { "contactPerson": "Maria Lopez", "email": "maria.lopez@example.com", "phone": "+ 800-4578001" }, "technicalContact": { "contactPerson": "Chris Miller", "email": "chris.miller@example.com", "phone": "+ 800-4578002" } } } } } } } } } } }, "/resellers/v6/catalog/priceandavailability" : { "post" : { "summary" : "Price and Availability", "tags" : [ "Product Catalog" ], "description" : "The PriceAndAvailability API, will retrieve Pricing, Availability, discounts, Inventory Location, Reserve Inventory for the products upto 50 products. As a reseller, you can search Price and Availability for both TS products and Cloud (Subscription) products in the same request. The reseller can pass either ingramPartNumber, vendorPartNumber, planId, or any of these together in the request body. If only subscription product is queried, the fields related to the TS product will show null values.", "operationId" : "post-priceandavailability", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "includeAvailability", "in" : "query", "description" : "Pass boolean value as input, if true the response will contain warehouse availability details, if false the response will not hold warehouse availability details", "required" : true, "schema" : { "type" : "boolean", "items" : { "type" : "boolean", "uniqueItems" : false } } }, { "name" : "includePricing", "in" : "query", "description" : "Pass boolean value as input, if true the response will contain Pricing details of the Product, if false the response will not hold Pricing details.", "required" : true, "schema" : { "type" : "boolean" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "With Cloud product": { "value" : { "products": [ { "ingramPartNumber": "01RW10" }, { "ingramPartNumber": "01RW18" }, { "vendorPartNumber": "65324819CA", "planID": "459468", "resourceId": "xxxxxx" }, { "planID": "358523", "resourceId": "xxxxxx" }, { "resourceId": "xxxxxx" }, { "vendorPartNumber": "65324861CA" } ] } }, "with one product" : { "value" : { "products" : [ { "ingramPartNumber" : "123512" } ] } }, "with multiple products (both valid)" : { "value" : { "products" : [ { "ingramPartNumber" : "123512" }, { "ingramPartNumber" : "QQ0202" } ] } }, "with multiple products (valid + invalid)" : { "value" : { "products" : [ { "ingramPartNumber" : "123512" }, { "ingramPartNumber" : "12351211" } ] } }, "Request with combination of part numbers" : { "value" : { "products" : [ { "ingramPartNumber" : "QQ0202" }, { "vendorPartNumber" : "5204303" } ] } }, "To find availability for particular Ingram Warehouse" : { "value" : { "products" : [ { "ingramPartNumber" : "3N7314" } ], "availabilityByWarehouse" : [ { "availabilityByWarehouseId" : "40" } ] } } }, "schema" : { "$ref" : "#/components/schemas/PriceAndAvailabilityRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PriceAndAvailabilityResponse" }, "examples" : { "TSProductSuccessResponse" : { "value" : [ { "productStatusMessage" : "ACOPS ARE AVAILABLE FOR THIS CUSTOMER AND SKU", "ingramPartNumber" : "4A0036", "vendorPartNumber" : "E2016HV", "extendedVendorPartNumber" : "E2016HV", "upc" : "0884116186519", "vendorNumber" : "802U", "vendorName" : "DELL", "description" : "20IN MONITOR E2016HV 210-AGLU  MNTR", "productClass" : "B", "uom" : "EA", "acceptBackOrder" : true, "productAuthorized" : true, "returnableProduct" : true, "endUserInfoRequired" : false, "govtSpecialPriceAvailable" : true, "availability" : { "available" : false, "totalAvailability" : 0, "availabilityByWarehouse" : [ { "warehouseId" : 20, "location" : "Fort Worth, TX", "quantityBackordered" : 0, "backOrderInfo" : [ { "quantity" : 1437, "etaDate" : "2025-01-01" }, { "quantity" : 8163, "etaDate" : "2026-01-01" } ] }, { "quantityAvailable" : 0, "warehouseId" : 40, "location" : "Carol Stream, IL", "quantityBackordered" : 156 }, { "quantityAvailable" : 0, "warehouseId" : 80, "location" : "Jonestown, PA", "quantityBackordered" : 70 }, { "quantityAvailable" : 0, "warehouseId" : 10, "location" : "Mira Loma, CA", "quantityBackordered" : 576 } ] }, "pricing" : { "mapPrice" : 0, "currencyCode" : "USD", "retailPrice" : 189.99, "customerPrice" : 74.34 }, "discounts" : [ { "specialPricing" : [ { "specialPricingAvailableQuantity" : 9999999, "specialPricingExpirationDate" : "2023-12-31", "specialBidNumber" : "TESTRKP1", "specialPricingMinQuantity" : 0, "specialPricingEffectiveDate" : "2022-03-24", "discountType" : "Special Bid", "specialPricingDiscount" : 6.74, "governmentDiscountType" : "Federal", "governmentDiscountedCustomerPrice" : 67.6 }, { "specialPricingAvailableQuantity" : 0, "specialPricingExpirationDate" : "2022-08-12", "specialPricingMinQuantity" : 0, "specialPricingEffectiveDate" : "2022-07-20", "discountType" : "Promo Discount", "specialPricingDiscount" : 135.56 } ], "quantityDiscounts" : [ { "currencyType" : "string", "amount" : 0, "quantity" : 0, "conditionType" : "string", "currencyCode" : "string" } ] } ], "bundlePartIndicator" : "boolean", "serviceFees" : [ { "conditionType" : "string", "description" : "string", "amount" : "decimal", "endDate" : "2023-01-27", "currencyCode" : "string" } ], "subscriptionPrice": null } ] }, "SubscriptionSuccessResponse" : { "value" : [ { "productStatusCode": null, "productStatusMessage": null, "ingramPartNumber": "", "vendorPartNumber": "", "extendedVendorPartNumber": null, "customerPartNumber": "", "upc": "", "partNumberType": null, "vendorNumber": null, "vendorName": null, "description": null, "productClass": null, "uom": null, "productStatus": null, "acceptBackOrder": null, "productAuthorized": null, "returnableProduct": null, "endUserInfoRequired": null, "govtSpecialPriceAvailable": null, "govtProgramType": null, "govtEndUserType": null, "availability": null, "reserveInventoryDetails": [], "reserveStockDetails": null, "pricing": null, "discounts": [], "bundlePartIndicator": null, "substitutePartDetails": [], "serviceFees": null, "subscriptionPrice": [ { "index": 0, "planID": "438294", "planUId": "12528688-7afe1867-10fb-4020-bbe3-7cce290a9e96-VA-888-104", "planName": "Microsoft 365 Business Premium (NCE COM ANN)", "planDescription": "Best for businesses that need all the apps and services included in Business Standard plus advanced cyber threat protection and device management. For businesses with up to 300 employees.", "groups": [ { "groupName": "NCE Microsoft 365 (Commercial)", "groupDescription": "The Microsoft 365 and Office 365 families are cloud-based services, designed to help meet your organization’s needs for robust security, reliability, and user productivity. They deliver the power of cloud productivity to businesses of all sizes, helping save time, money, and free up valued resources." } ], "billingPeriod": { "billingPeriodUnit": "YEARS", "billingPeriod": 1 }, "subscriptionPeriod": [ { "subscriptionPeriodUnit": "YEARS", "subscriptionPeriod": "1" } ], "options": [ { "resourceId": "15613359", "resourceUId": "7002bc2a-1f31-4b94-ab81-456c73ad9212", "resourceName": "Microsoft 365 Business Premium", "vendorPartNumber": "CFQ7TTC0LCHC:0002", "minUnits": 1.0, "maxUnits": 300.0, "dependson": null, "recurringpricemodel": "FLAT", "unitOfMeasure": "Licenses", "resourcePricing": [ { "name": "recurring", "currencyCode": "USD", "amountRetail": null, "subscriptionPeriod": "1 YEARS", "msrp": 264.0, "unitPrice": 221.76, "margin": 16.00, "quantity": "1" } ], "discounts": [], "fees": [ { "type": "Recurring", "price": 221.76, "msrp": 264.0, "code": "USD" }, { "type": "Overuse", "price": 0.0, "msrp": 0.0, "code": "USD" }, { "type": "Setup", "price": 0.0, "msrp": 0.0, "code": "USD" } ] } ] }, { "index": 1, "planID": "438295", "planUId": "12528688-e7399799-549f-4a0d-b37a-d1b862138708-VA-888-104", "planName": "Microsoft 365 Business Premium (NCE COM MTH)", "planDescription": "Best for businesses that need all the apps and services included in Business Standard plus advanced cyber threat protection and device management. For businesses with up to 300 employees.", "groups": [ { "groupName": "NCE Microsoft 365 (Commercial)", "groupDescription": "The Microsoft 365 and Office 365 families are cloud-based services, designed to help meet your organization’s needs for robust security, reliability, and user productivity. They deliver the power of cloud productivity to businesses of all sizes, helping save time, money, and free up valued resources." } ], "billingPeriod": { "billingPeriodUnit": "MONTHS", "billingPeriod": 1 }, "subscriptionPeriod": [ { "subscriptionPeriodUnit": "MONTHS", "subscriptionPeriod": "1" }, { "subscriptionPeriodUnit": "YEARS", "subscriptionPeriod": "1" } ], "options": [ { "resourceId": "15613374", "resourceUId": "7002bc2a-1f31-4b94-ab81-456c73ad9212", "resourceName": "Microsoft 365 Business Premium", "vendorPartNumber": "CFQ7TTC0LCHC:0002", "minUnits": 1.0, "maxUnits": 300.0, "dependson": null, "recurringpricemodel": "FLAT", "unitOfMeasure": "Licenses", "resourcePricing": [ { "name": "recurring", "currencyCode": "USD", "amountRetail": null, "subscriptionPeriod": "1 MONTHS", "msrp": 26.4, "unitPrice": 24.0, "margin": 9.09, "quantity": "1" }, { "name": "recurring", "currencyCode": "USD", "amountRetail": null, "subscriptionPeriod": "1 YEARS", "msrp": 22.0, "unitPrice": 20.0, "margin": 9.09, "quantity": "1" } ], "discounts": [], "fees": [ { "type": "Recurring", "price": 20.0, "msrp": 22.0, "code": "USD" }, { "type": "Overuse", "price": 0.0, "msrp": 0.0, "code": "USD" }, { "type": "Setup", "price": 0.0, "msrp": 0.0, "code": "USD" } ] } ] } ] } ] } } } } }, "207" : { "description" : "Multi Status", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PriceAndAvailabilityResponse" }, "examples" : { "with multiple products (valid + invalid)" : { "value" : [ { "productStatusMessage" : "ACOPS ARE AVAILABLE FOR THIS CUSTOMER AND SKU", "ingramPartNumber" : "123512", "vendorPartNumber" : "LS1016A-CISCO", "customerPartNumber" : "A5-8963TEST", "upc" : "0718908728116", "partNumberType" : "T", "vendorNumber" : "1234", "vendorName" : "INTERNAL", "description" : "6FT PARALLEL PRINTER DB25M TO SVCS CENT36M PRO SERIES 28AWG ROHS", "productClass" : "P", "uom" : "EA", "acceptBackOrder" : true, "productAuthorized" : true, "returnableProduct" : true, "endUserInfoRequired" : true, "availability" : { "available" : true, "totalAvailability" : 240479, "availabilityByWarehouse" : [ { "location" : "Fort Worth, TX", "warehouseId" : "20", "quantityAvailable" : 105415 }, { "warehouseId" : "25", "quantityAvailable" : 100000 }, { "location" : "Millington, TN", "warehouseId" : "30", "quantityAvailable" : 9981 }, { "location" : "Carol Stream, IL", "warehouseId" : "40", "quantityAvailable" : 1049 }, { "location" : "Jonestown, PA", "warehouseId" : "80", "quantityAvailable" : 995 }, { "location" : "Mira Loma, CA", "warehouseId" : "10", "quantityAvailable" : 23039 }, { "warehouseId" : "81" }, { "warehouseId" : "05" } ], "pricing" : { "currencyCode" : "USD", "retailPrice" : 10, "mapPrice" : 540.25, "customerPrice" : 5.43 } } }, { "productStatusCode" : "E", "productStatusMessage" : "Product not found for IngramPartNumber: 12351211", "ingramPartNumber" : "12351211" } ] } } } } }, "400" : { "description" : "Bad Request", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Single Error" : { "value" : { "errors" : [ { "id" : "-bw0a10t1-2021-02-19T11:04:37.312-08:00", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CorrelationID", "value" : "", "message" : "IM-CorrelationID cannot be blank" } ] } ] } } } } } }, "401" : { "description" : "Unauthorized" }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "C123-bw0a10u3-2021-02-19T11:12:26.436-08:00", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred, please contact support team for more details." } ] } } } } } } } } }, "/resellers/v6/catalog" : { "get" : { "summary" : "Search Products", "tags" : [ "Product Catalog" ], "description" : "Using the Product Search API endpoint, as a reseller you can search both TS products and subscription products in one request.

For searching TS Products, search the Ingram Micro product catalog by providing any of the information in the keyword(Ingram part number / vendor part number/ product description / UPC.

For searching subscriptions, a customer can use GroupName and/or PlanName or plan ID. The customer can search only subscription products by passing IM::subscription as the type. These filters can be used individually or in combination with other filters. When a customer searches for subscription products only, the TS product catalog should be the NULL object.", "operationId" : "get-reseller-v6-productsearch", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "pageNumber", "in" : "query", "description" : "Current page number. Default is 1", "required" : false, "schema" : { "type" : "integer", "default" : "1", "format" : "int32" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "pageSize", "in" : "query", "description" : "Number of records required in the call - max records 100 per page", "required" : false, "schema" : { "type" : "integer", "default" : "25", "format" : "int32" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Sender Identification text", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "type", "in" : "query", "description" : "The SKU type of product. One of Physical, Digital, or Any.", "required" : false, "schema" : { "type" : "string", "enum" : [ "IM::physical", "IM::digital", "IM::any", "IM::subscription" ] } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "hasDiscounts", "in" : "query", "description" : "Specifies if there are discounts available for the product.", "required" : false, "schema" : { "type" : "string", "example" : true } }, { "name" : "vendor", "in" : "query", "description" : "The name of the vendor/manufacturer of the product.", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "uniqueItems" : false } } }, { "name" : "vendorPartNumber", "in" : "query", "description" : "The vendors part number for the product.", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "uniqueItems" : false } } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "Accept-Language", "in" : "header", "description" : "Header to the API calls, the content will help us identify the response language.", "required" : false, "schema" : { "type" : "string", "default" : "en" } }, { "name" : "vendorNumber", "in" : "query", "description" : "Vendor number of the product", "required" : false, "schema" : { "type" : "string" } }, { "name" : "keyword", "in" : "query", "description" : "Keyword search,can be ingram part number or vendor part number or product title or vendor nameKeyword search. Can be Ingram Micro part number, vender part number, product title, or vendor name.", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "uniqueItems" : false } } }, { "name" : "category", "in" : "query", "description" : "The category of the product. Example: Displays.", "required" : false, "schema" : { "type" : "string", "example" : "Accessories" } }, { "name" : "skipAuthorisation", "in" : "query", "description" : "This parameter is True when you want Skip the authorization, so template will work like current B2b template.", "required" : false, "schema" : { "type" : "string", "example" : true } }, { "name" : "groupName", "in" : "query", "description" : "Name of the group.", "required" : false, "schema" : { "type" : "string", "example" : "NCE Microsoft 365 (Commercial)" } }, { "name" : "planName", "in" : "query", "description" : "Name of the Plan.", "required" : false, "schema" : { "type" : "string", "example" : "Microsoft Defender for Endpoint P2 (NCE COM MTH)" } }, { "name" : "planId", "in" : "query", "description" : "ID of the Plan.", "required" : false, "schema" : { "type" : "string", "example" : "471490" } }, { "name" : "showGroupInfo", "in" : "query", "description" : "In case of value true, below Group related information will displayed without the plan info. Group Name, Group Description, Number of plans, link in the group. A link will be provided if customer want to see all the plans in that group.", "required" : false, "schema" : { "type" : "boolean", "example" : true } } ], "responses" : { "200" : { "description" : "a ProductSearchv6ResponseElement to be returned", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" }, "description" : "Sender Identification text ." } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductSearch_Response" }, "examples" : { "TSProductSuccessResponse" : { "value" : { "recordsFound" : 1180, "pageSize" : 25, "pageNumber" : 2, "catalog" : [ { "description" : " CLASS 10 100MB/S UHS-I CARD", "category" : "device storage", "subCategory" : "Flash Memory Devices", "productType" : "", "ingramPartNumber" : "1A8249", "vendorPartNumber" : "SDSQUNC-016G-AN6IA", "upcCode" : "0619659134587", "vendorName" : "Sandisk Mobile", "endUserRequired" : "false", "hasDiscounts" : "", "type" : "IM::Physical", "discontinued" : "false", "newProduct" : "false", "directShip" : "false", "hasWarranty" : "false", "extraDescription" : "IPAD AIR CELL 256GB SKY BLUE ", "replacementSku" : "", "authorizedToPurchase" : "true", "links" : [ { "topic" : "catalog", "href" : "/catalog/1A8249", "type" : "GET" } ] } ], "nextPage" : "/resellers/v6/catalog?keyword=mobilepageSize=25&pageNumber=3", "previousPage" : "/resellers/v6/catalog?keyword=mobilepageSize=25&pageNumber=1" } }, "SubscriptionSuccessResponse" : { "value" : { "recordsFound" : 1180, "pageSize" : 25, "pageNumber" : 2, "subscriptionCatalog" : [ { "plans": [ { "planId": "438323", "planName": "Office 365 E5 OVG (NCE COM MTH)", "planDescription": "The Office suite, plus email, instant messaging, HD video conferencing, 1 TB personal file storage and sharing, and advanced security, analytics and Audio conferencing.", "subscriptionPeriodSummary": [ { "subscriptionPeriodUnit": "MONTHS", "subscriptionPeriod": "1" } ], "links": [ { "topic": "catalog", "href": "/resellers/v6/catalog/priceandavailability", "type": "POST" }, { "topic": "catalog", "href": "/resellers/v6/catalog/details?planId=438323", "type": "GET" } ] } ] } ], "nextPage" : "/resellers/v6/catalog?pageSize=25&pageNumber=3&type=IM::subscription&showGroupInfo=False", "previousPage" : "/resellers/v6/catalog?pageSize=25&pageNumber=3&type=IM::subscription&showGroupInfo=False" } }, "SubscriptionWithGroupInfoSuccessResponse" : { "value" : { "recordsFound" : 1180, "pageSize" : 25, "pageNumber" : 2, "subscriptionCatalog" : [ { "groupName": "NCE Microsoft 365 (Commercial)", "groupDescription": "The Microsoft 365 and Office 365 families are cloud-based services, designed to help meet your organization’s needs for robust security, reliability, and user productivity. They deliver the power of cloud productivity to businesses of all sizes, helping save time, money, and free up valued resources.", "numberOfPlans": "1", "link": "/resellers/v6/catalog?pageSize=25&pageNumber=1&groupName=NCE Microsoft 365 (Commercial)&showGroupInfo=false&planId=438323" } ], "nextPage" : "/resellers/v6/catalog?pageSize=10&pageNumber=3&type=IM::subscription&showGroupInfo=True", "previousPage" : "/resellers/v6/catalog?pageSize=10&pageNumber=1&type=IM::subscription&showGroupInfo=True" } } } } } }, "400" : { "description" : "Bad Request", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" }, "description" : "Sender Identification text ." } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "id" : "C123-bw0a10u3-2021-03-18T11:12:26.436-08:00", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "message" : "Required field is missing" }, { "field" : "IM-CustomerNumber", "message" : "Required field is missing" } ] } ] } } } } } }, "404" : { "description" : "No Content", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "404 - Not Found" : { "value" : { "errors" : [ { "id" : 123, "type" : "Validation error", "message" : "No Records Found" } ] } } } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" }, "description" : "Sender Identification text ." } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "C123-bw0a10u3-2021-03-18T11:12:26.436-08:00", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred, please contact support team for more details" } ] } } } } } } } } }, "/resellers/v6/catalog/details/{ingramPartNumber}" : { "get" : { "summary" : "Product Details", "tags" : [ "Product Catalog" ], "description" : "Search all the product-related details using a unique Ingram Part Number.", "operationId" : "get-reseller-v6-productdetail", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "ingramPartNumber", "in" : "path", "description" : "Ingram Micro unique part number for the product.*Required for technology solution (Non-cloud subscription) products. ", "schema" : { "type" : "string", "maxLength" : 6, "example" : "6YE881" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Sender Identification text", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } },{ "name" : "vendorPartNumber", "in" : "query", "description" : "Vendor’s part number for the product.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "planName", "in" : "query", "description" : "Name of the subscription plan", "required" : false, "schema" : { "type" : "string" } }, { "name" : "planId", "in" : "query", "description" : "Id of the subscription plan.\n\n To search for details of subscription products, customer must pass either vendorPartNumber, planName or planId.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductDetailResponse" }, "examples" : { "SuccessResponseTsProduct" : { "description" : "OK", "value" : { "ingramPartNumber" : "5348387", "vendorPartNumber" : "20VE0117MH", "productAuthorized" : "True", "description" : "TB 15 G2 CI5-1135G7 8/256GB 15.6 W11P", "upc" : "196119831243", "productCategory" : "Computers Test Duplicate", "productSubcategory" : "Notebooks & Tablets", "vendorName" : "Lenovo", "vendorNumber" : "0000500082", "productStatusCode" : null, "productClass" : null, "indicators" : { "hasWarranty" : true, "isNewProduct" : false, "hasReturnLimits" : false, "isBackOrderAllowed" : false, "isShippedFromPartner" : false, "isReplacementProduct" : false, "replacementType" : null, "isDirectship" : false, "isDownloadable" : false, "isDigitalType" : false, "skuType" : "M", "hasStdSpecialPrice" : false, "hasAcopSpecialPrice" : false, "hasAcopQuantityBreak" : false, "hasStdWebDiscount" : false, "hasAcopWebDiscount" : false, "hasSpecialBid" : false, "isExportableToCountry" : false, "isDiscontinuedProduct" : true, "isRefurbished" : false, "isReturnableProduct" : false, "isIngramShip" : true, "isEnduserRequired" : false, "isHeavyWeight" : false, "hasLtl" : false, "isClearanceProduct" : false, "hasBundle" : false, "isOversizeProduct" : false, "isPreorderProduct" : false, "isLicenseProduct" : false, "isDirectshipOrderable" : true, "isServiceSku" : false, "isConfigurable" : false }, "ciscoFields" : { "productSubGroup" : null, "serviceProgramName" : null, "itemCatalogCategory" : null, "configurationIndicator" : null, "internalBusinessEntity" : null, "itemType" : null, "globalListPrice" : null }, "warrantyInformation" : [ ], "additionalInformation" : { "productWeight" : [ { "plantId" : "NL01", "weight" : 2.6, "weightUnit" : "KG" } ], "isBulkFreight" : false, "height" : "8", "width" : "31", "length" : "50", "netWeight" : null, "dimensionUnit" : "CM" } } }, "SuccessResponseCloudProduct" : { "description" : "OK", "value" : { "ingramPartNumber": null, "vendorPartNumber": null, "customerPartNumber": null, "productAuthorized": null, "description": null, "upc": null, "productCategory": null, "productSubCategory": null, "vendorName": null, "vendorNumber": null, "productStatusCode": null, "productClass": null, "indicators": null, "ciscoFields": null, "warrantyInformation": null, "additionalInformation": null, "subscriptionDetails": [ { "planId": "438292", "planName": "Microsoft 365 Business Standard (NCE COM ANN)", "planDescription": "Best for businesses that need Office apps across devices plus professional email, cloud file storage, and online meetings & chat. For businesses with up to 300 employees.", "groups": [ { "groupName": "NCE Microsoft 365 (Commercial)", "groupDescription": "The Microsoft 365 and Office 365 families are cloud-based services, designed to help meet your organization’s needs for robust security, reliability, and user productivity. They deliver the power of cloud productivity to businesses of all sizes, helping save time, money, and free up valued resources." } ], "subscriptionPeriod": [ { "subscriptionPeriodUnit": "YEAR", "subscriptionPeriod": "1" } ], "billingPeriod": { "billingPeriod": "1", "billingPeriodUnit": "YEAR" }, "options": [ { "resourceId": "15613396", "resourceName": "Microsoft 365 Business Standard", "vendorPartNumber": "CFQ7TTC0LDPB:0001", "minUnits": "1", "maxUnits": "300", "dependsOn": null } ], "links": [ { "topic": "catalog", "href": "/resellers/v6/catalog/priceandavailability", "type": "POST" } ], "previousPage": "", "nextPage": "" }, { "planId": "438381", "planName": "Microsoft 365 Business Standard (NCE COM MTH)", "planDescription": "Best for businesses that need Office apps across devices plus professional email, cloud file storage, and online meetings & chat. For businesses with up to 300 employees.", "groups": [ { "groupName": "NCE Microsoft 365 (Commercial)", "groupDescription": "The Microsoft 365 and Office 365 families are cloud-based services, designed to help meet your organization’s needs for robust security, reliability, and user productivity. They deliver the power of cloud productivity to businesses of all sizes, helping save time, money, and free up valued resources." } ], "subscriptionPeriod": [ { "subscriptionPeriodUnit": "MONTH", "subscriptionPeriod": "1" }, { "subscriptionPeriodUnit": "YEAR", "subscriptionPeriod": "1" } ], "billingPeriod": { "billingPeriod": "1", "billingPeriodUnit": "MONTH" }, "options": [ { "resourceId": "15612791", "resourceName": "Microsoft 365 Business Standard", "vendorPartNumber": "CFQ7TTC0LDPB:0001", "minUnits": "1", "maxUnits": "300", "dependsOn": null } ], "links": [ { "topic": "catalog", "href": "/resellers/v6/catalog/priceandavailability", "type": "POST" } ], "previousPage": "", "nextPage": "" } ] } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "400" : { "description" : "Bad Request", "value" : { "errors" : [ { "traceid" : "123", "type" : "errors/bad-request", "message" : "Input passed is not in right or expected format. Model Binding Error Happens at Global Model Binding Exception Handler.", "fields" : [ { "field" : "IM-CustomerNumber", "message" : "The customerNumber field is required.", "value" : "" } ] } ] } } } } } }, "404" : { "description" : "No Content", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "404 - Not Found" : { "value" : { "errors" : [ { "id" : 123, "type" : "Validation error", "message" : "No Records Found" } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "500" : { "description" : "Internal Server Error", "value" : { "errors" : [ { "id" : "C123-bw0a10u3-2021-02-19T11:12:26.436-08:00", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred, please contact support team for more details" } ] } } } } } } } } }, "/resellers/v1/webhooks/availabilityupdate" : { "post" : { "summary" : "Stock Update", "tags" : [ "StockUpdate" ], "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "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/" } }, { "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 ley is given at link https://developer.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==" } } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "Order with Header Comments" : { "value" : { "topic" : "resellers/catalog", "event" : "im::updated", "eventTimeStamp" : "2021-11-01T13:02:06.369Z", "eventId" : "AH7ESSIWSIO22Y77DD", "resource" : [ { "eventType" : "IM::STOCK_UPDATE", "ingramPartNumber" : "5CX579", "vendorPartNumber" : "710412-001-BTI", "vendorName" : "BATTERY TECHNOLOGY INC.", "upcCode" : "0886734869201", "skuStatus" : null, "backOrderFlag" : "Y", "totalAvailability" : "120", "links" : [ { "topic" : "orders", "href" : "/resellers/v5/catalog/5CX579", "type" : "GET" } ] }, { "eventType" : "IM::STOCK_UPDATE", "ingramPartNumber" : "5CT275", "vendorPartNumber" : "AC-U90W-HP", "vendorName" : "BATTERY TECHNOLOGY INC.", "upcCode" : "0745473120182", "skuStatus" : null, "backOrderFlag" : "Y", "totalAvailability" : "120", "links" : [ { "topic" : "orders", "href" : "/resellers/v6/catalog/5CT275", "type" : "GET" } ] } ] } } }, "schema" : { "$ref" : "#/components/schemas/AvailabilityAsyncNotificationRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" }, "500" : { "description" : "Internal Server Error" } } } }, "/resellers/v1/webhooks/QuoteCreate" : { "post" : { "summary" : "Quote Create", "tags" : [ "QuoteCreate" ], "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "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/" } }, { "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 ley is given at link https://developer.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==" } } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "Quote Create with Header Comments" : { "value" : { "topic": "IM::quote_create_sandbox", "event": "im::created", "eventTimeStamp": "2025-02-19T04:51:08.0273449-08:00", "eventId": "5NMJ4EYR32N5Y88UJC", "eventType": "IM::quote_create_sandbox", "resource": { "quoteName": "79203425", "quoteNumber": "QUO-765100-T0Y4C4", "quoteGuid": "3006d220-c0ee-ef11-be21-6045bd04884b", "revision": "0", "ingramQuoteDate": "2025-02-19T04:50:52", "lastModifiedDate": "2025-02-19T04:51:01", "ingramQuoteExpiryDate": "2025-02-20T00:00:00", "currencyCode": "USD", "specialBidId": "79203425", "specialBidEffectiveDate": "2025-02-19T00:00:00", "specialBidExpirationDate": "2025-07-20T00:00:00", "status": "Ready To Order", "closingReason": "", "customerNeed": "", "proposedSolution": "", "introPreamble": "Thank you for contacting Ingram Micro. We value your business greatly and will continue to deliver the services you need to retain it. This quote is not intended to represent the entire conversation; only what was relevant to the solution you requested. We make every effort to provide a complete and correct solution. However, the accuracy of the solution provided is dependent on the information gathered. If relevant information is not provided by our customer, Ingram Micro cannot be held responsible. We urge you to review this quote fully, to ensure it reflects all of your required specifications. If you have additional questions, please contact your designated Ingram Micro contact. Remember to reference your Quote Number.", "purchaseInstructions": "For specific pricing and to order the above products, you may:Call the Ingram Micro Sales department at 1.800.456.8000Some products may be orderable on XVANTAGE at https://usa.ingrammicro.com/cep/app/loginPlease provide the following: Your PO number Your fax numberShipping InstructionsEnd customer PO numberEnd customer license, contract or authorization numberEnd customer company name End customer addressEnd customer contactEnd customer contact email addressEnd customer contact phone numberEnd customer contact fax numberThank you for your order!This offer to sell the listed product(s) is subject to product availability and Ingram Micro's standard terms and conditions that are published on http://www.ingrammicro.com. Prices are subject to change without notice. Please contact the Ingram Micro Sales desk at 1.800.456.8000 if you have any additional questions.", "legalTerms": "This offer to sell the listed product(s) is subject to product availability and Ingram Micro's standard terms and conditions that are published on http://www.ingrammicro.com. Prices are subject to change without notice. Please contact the Ingram Micro Sales desk at 1.800.456.8000 if you have any additional questions.", "resellerInfo": { "contact": "Saiteja T", "companyName": "Converge Technology Solutions", "email": "saiteja.thogiti@ingrammicro.com", "phoneNumber": "7166333600", "customerNumber": "20222222" }, "endUserInfo": { "contact": "Jim Bennett", "companyName": "INGRAM MICRO INC", "addressLine1": "1600 E SAINT ANDREW PL", "city": "SANTA ANA", "state": "CA", "email": "james.bennett@ingrammicro.com", "phoneNumber": "+18004568000", "postalCode": "92705" }, "products": [ { "quoteProductGuid": "2b30e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "1.0", "quantity": 10.0, "notes": "", "ean": "", "coo": "US", "ingramPartNumber": "08JV76", "vendorPartNumber": "CW9162I-MR", "description": "Catalyst 9162I AP (W6E, tri-band 2x2) w/Meraki", "weight": 9.45, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "NONCONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750666;0;;", "vendorName": "CISCO - MERAKI", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 400.39, "msrp": 1251.23, "extendedMsrp": 12512.3, "extendedQuotePrice": 4003.9, "discountOffList": "68.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "2830e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "2.0", "quantity": 10.0, "notes": "", "ean": "", "coo": "US", "ingramPartNumber": "QX9285", "vendorPartNumber": "LIC-ENT-3YR", "description": "Meraki MR Enterprise License, 3YR", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "NONCONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750667;0;C30375359;", "vendorName": "CISCO - MERAKI", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 239.34, "msrp": 451.58, "extendedMsrp": 4515.8, "extendedQuotePrice": 2393.4, "discountOffList": "47.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "2530e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.0", "quantity": 1.0, "notes": "", "ean": "", "coo": "US", "ingramPartNumber": "HF6409", "vendorPartNumber": "C9200CX-8UXG-2X-A", "description": "Catalyst 9000 Compact Switch 8 port UPoE with 4xmGig,240W,A", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "CONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750668;0;C42167708;", "vendorName": "CISCO - HW SWITCHES DT", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 2096.63, "msrp": 3437.1, "extendedMsrp": 3437.1, "extendedQuotePrice": 2096.63, "discountOffList": "39.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "2230e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.0.1", "quantity": 1.0, "notes": "", "ean": "", "coo": "US", "ingramPartNumber": "JC6467", "vendorPartNumber": "CON-L1NCD-CX9293CX", "description": "CX LEVEL 1 8X7NCD Catalyst 9000 Compact Switch 8 port UPoE", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "SERVICE", "quoteProductsSupplierPartAuxiliaryId": "12752750669;12752750668;;", "vendorName": "CISCO - CISCO CCW SERVICES", "terms": "36", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 785.64, "msrp": 1053.0, "extendedMsrp": 1053.0, "extendedQuotePrice": 785.64, "discountOffList": "25.39", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "1f30e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.1", "quantity": 1.0, "notes": "", "ean": "", "coo": "", "ingramPartNumber": "-", "vendorPartNumber": "C9200CX-DNA-A-8", "description": "C9200CX Cisco DNA Advantage, 8-Port Term Licenses", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "NONCONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750670;12752750668;C18468853;", "vendorName": "CISCO - CDW ONLY MULTIYEAR SMARTNET", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 0.0, "msrp": 0.0, "extendedMsrp": 0.0, "extendedQuotePrice": 0.0, "discountOffList": "0.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "1c30e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.1.0.1", "quantity": 1.0, "notes": "", "ean": "", "coo": "US", "ingramPartNumber": "10LG70", "vendorPartNumber": "CON-L1SWT-C9201CCD", "description": "CX LEVEL 1 SW SUB C9200CX Cisco DNA Advantage, 8-Port Term", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "SERVICE", "quoteProductsSupplierPartAuxiliaryId": "12752750671;12752750670;;", "vendorName": "CISCO - CISCO CCW SERVICES", "terms": "36", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 91.77, "msrp": 123.0, "extendedMsrp": 123.0, "extendedQuotePrice": 91.77, "discountOffList": "25.39", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "1930e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.1.1", "quantity": 1.0, "notes": "", "ean": "", "coo": "US", "ingramPartNumber": "06ZH17", "vendorPartNumber": "C9200CX-DNAA8-3Y", "description": "C9200CX Cisco DNA Advantage, 3Y Term License, 8P", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "SUBSCRIPTION", "quoteProductsSupplierPartAuxiliaryId": "12752750672;12752750670;;", "vendorName": "CISCO - HW SWITCHES DT", "terms": "36", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 815.97, "msrp": 1337.66, "extendedMsrp": 1337.66, "extendedQuotePrice": 815.97, "discountOffList": "39.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "1630e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.2", "quantity": 1.0, "notes": "", "ean": "", "coo": "", "ingramPartNumber": "-", "vendorPartNumber": "CAB-TA-NA", "description": "North America AC Type A Power Cable", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "NONCONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750673;12752750668;C59406480;", "vendorName": "CISCO - CDW ONLY MULTIYEAR SMARTNET", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 0.0, "msrp": 0.0, "extendedMsrp": 0.0, "extendedQuotePrice": 0.0, "discountOffList": "0.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "1330e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.3", "quantity": 1.0, "notes": "", "ean": "", "coo": "", "ingramPartNumber": "-", "vendorPartNumber": "C9200CX-NW-A-8", "description": "C9200CX Network Advantage, 8-port license", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "NONCONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750674;12752750668;C28122329I;", "vendorName": "CISCO - CDW ONLY MULTIYEAR SMARTNET", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 0.0, "msrp": 0.0, "extendedMsrp": 0.0, "extendedQuotePrice": 0.0, "discountOffList": "0.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "1030e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.4", "quantity": 1.0, "notes": "", "ean": "", "coo": "", "ingramPartNumber": "-", "vendorPartNumber": "NETWORK-PNP-LIC", "description": "Network Plug-n-Play Connect for zero-touch device deployment", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "NONCONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750675;12752750668;C75581486I;", "vendorName": "CISCO - CDW ONLY MULTIYEAR SMARTNET", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 0.0, "msrp": 0.0, "extendedMsrp": 0.0, "extendedQuotePrice": 0.0, "discountOffList": "0.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "0d30e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "3.5", "quantity": 1.0, "notes": "", "ean": "", "coo": "", "ingramPartNumber": "-", "vendorPartNumber": "SCAT9200CXUK9-1712", "description": "Cisco Catalyst 9200CX XE 17.12 UNIVERSAL", "weight": 0.0, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "NONCONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750676;12752750668;C7682396I;", "vendorName": "CISCO - CDW ONLY MULTIYEAR SMARTNET", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 0.0, "msrp": 0.0, "extendedMsrp": 0.0, "extendedQuotePrice": 0.0, "discountOffList": "0.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } }, { "quoteProductGuid": "0a30e226-c0ee-ef11-be21-6045bd04884b", "lineNumber": "4.0", "quantity": 3.0, "notes": "", "ean": "", "coo": "US", "ingramPartNumber": "LB7752", "vendorPartNumber": "GLC-LH-SMD=", "description": "1000BASE-LX/LH SFP transceiver module, MMF/SMF, 1310nm, DOM", "weight": 0.04, "weightUom": "", "isSuggestionProduct": false, "vpnCategory": "NONCONFIGURABLE", "quoteProductsSupplierPartAuxiliaryId": "12752750677;0;;", "vendorName": "", "terms": "", "planDescription": "", "isSubscription": false, "resellerMargin": "", "price": { "quotePrice": 473.25, "msrp": 1213.46, "extendedMsrp": 3640.38, "extendedQuotePrice": 1419.75, "discountOffList": "61.00", "totalVisibleReserveQuantity": 0, "type": "", "recurringPriceModel": "" } } ], "productsCount": 12, "extendedMsrpTotal": 26619.24, "quantityTotal": 32.0, "extendedQuotePriceTotal": 11607.06, "totalQuoteAmount": "11607.06", "additionalAttributes": [ { "attributeName": "dealId", "attributeValue": "79203425" }, { "attributeName": "vendorName", "attributeValue": "CISCO - CDW ONLY MULTIYEAR SMARTNET" } ] } } } }, "schema" : { "$ref" : "#/components/schemas/OrdercreateWebhook" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" }, "500" : { "description" : "Internal Server Error" } } } }, "/resellers/v1/webhooks/orderstatusevent" : { "post" : { "summary" : "Order Status", "tags" : [ "OrderStatus" ], "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "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/" } }, { "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 ley is given at link https://developer.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==" } } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "Order with Header Comments" : { "value" : { "topic" : "resellers/orders", "event" : "im::updated", "eventTimeStamp" : "2021-11-01T13:02:06.369Z", "eventId" : "N01CIB9VVFYKR9J6ZW", "resource" : [ { "eventType" : "im::order_shipped", "orderNumber" : "20-RD128", "customerOrderNumber" : "ZENPO", "orderEntryTimeStamp" : "2020-04-03T08:54:39-07:00", "lines" : [ { "ingramLineNumber" : "001", "subOrderNumber" : "20-RD128-21", "lineStatus" : "IM::shipped", "ingramPartNumber" : "5CX895", "vendorPartNumber" : "TC57HO-1PEZU4P-NA", "requestedQuantity" : 3, "shippedQuantity" : 2, "backOrderedQuantity" : 1, "shipmentDetails" : [ { "shipmentDate" : "2019-11-06", "shipFromWarehouseId" : "10", "warehouseName" : "New York", "carrierCode" : "4M", "carrierName" : "SMARTPOST-BM", "packageDetails" : [ { "cartonNumber" : "", "quantityInbox" : "", "trackingNumber" : "" } ] } ], "serialNumberDetails" : [ { "serialNumber" : "123123123" } ], "customerLineNumber": "001" } ], "links": [ { "topic": "orders", "href": "/resellers/v6/orders/20-RD128", "type" : "GET" } ] } ] } } }, "schema" : { "$ref" : "#/components/schemas/OrderStatusAsyncNotificationRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" }, "500" : { "description" : "Internal Server Error" } } } }, "/resellers/v6/orders" : { "post" : { "summary" : "Create your Order v6", "tags" : [ "Orders" ], "description" : "Instantly create and place orders. The POST API supports stocked SKUs as well as licensing and warranties SKUs.\nIM-CustomerNumber, IM-CountryCode, IM-SenderID and IM-CorrelationID are required parameters.\nIngram Micro recommends that you provide the ingrampartnumber for each SKU contained in each order.\nNOTE: You must have net terms to use the Ingram Micro Order Create API. Ingram Micro offers trade credit when using our APIs, and repayment is based on net terms. For example, if your net terms agreement is net-30, you will have 30 days to make a full payment. Ingram Micro does not allow credit card transactions for API ordering. ", "operationId" : "post-createorder_v6", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "Order with Header Comments" : { "value" : { "customerOrderNumber" : "SWAGGER-01", "notes" : "This is the field for comments", "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "Shipping Instructions and Signature Required" : { "value" : { "customerOrderNumber" : "SHIPVIAeg", "shipToInfo" : { "email" : "dummy.email@ingrammicro.co.in" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "4U0212", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ], "shipmentDetails" : { "signatureRequired" : "true", "shippingInstructions" : "This is the shipping instruction for this order" } } }, "Combined Order(Stock + Direct ship)" : { "value" : { "customerOrderNumber" : "Tejal899", "endCustomerOrderNumber" : "ENDUSER", "notes" : "direct ship and stock Order", "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 1 }, { "customerLineNumber" : "1", "ingramPartNumber" : "RQ6000", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "Ship from warehouseid" : { "value" : { "customerOrderNumber" : "newcustomerPO4", "notes" : "this is an partial order process sample", "billToAddressId" : "000", "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "shipFromWarehouseId", "attributeValue" : "10" }, { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "Ship Complete Order" : { "value" : { "customerOrderNumber" : "THIS_IS-121", "shipToInfo" : { "email" : "dummy.email@ingrammicro.co.in" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "4U0212", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowPartialOrder", "attributeValue" : "true" }, { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ], "shipmentDetails" : { "shipComplete" : "true" } } }, "Partial Order and Special Bid Number" : { "value" : { "customerOrderNumber" : "newcustomerPO4", "specialBidNumber" : "43426380", "notes" : "this is an partial order process sample", "billToAddressId" : "000", "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 1 }, { "customerLineNumber" : "1", "ingramPartNumber" : "XXXXXX", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowPartialOrder", "attributeValue" : "true" }, { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "Backordered Request" : { "value" : { "customerOrderNumber" : "newcustomerP1O6", "notes" : "this is backorder sample", "acceptBackOrder" : "true", "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "Order with CarrierCode & Freight Account Number" : { "value" : { "customerOrderNumber" : "SPCLBID1", "notes" : "Sample Order with Required Shipvia", "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 1, "unitPrice" : 60 } ], "shipmentDetails" : { "carrierCode" : "RG", "freightAccountNumber" : "FRT100" }, "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "Order on CustomerHold" : { "value" : { "customerOrderNumber" : "SWAGGER-01", "notes" : "CustomerHoldOrderSample", "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" }, { "attributeName" : "allowOrderOnCustomerHold", "attributeValue" : "true" } ] } }, "Requested Unit Price or Price Variance" : { "value" : { "customerOrderNumber" : "SWAGGER-02", "specialBidNumber" : "43426380", "notes" : "Test Order for Unit Price", "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "TSXML1", "quantity" : 1, "unitPrice" : 10 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "Direct Ship with EndUser Info" : { "value" : { "customerOrderNumber" : "newcustomerPO9", "notes" : "This is enduser info Order", "shipToInfo" : { "contact" : "Customer 1", "companyName" : "ABC priavte Ltd", "addressLine1" : "7001 SW 24th Ave", "addressLine2" : "testing", "city" : "Gainesville", "state" : "FL", "postalCode" : "326070001", "countryCode" : "US", "phoneNumber" : "987654321", "email" : "testing@yaho.com" }, "endUserInfo" : { "endUserId" : "", "companyName" : "MEDECISION INC", "contact" : "AARON RICCITELLI", "addressLine1" : "601 LEE RD", "city" : "wayne", "state" : "pa", "postalCode" : "190875607", "countryCode" : "US", "phoneNumber" : "6105400202", "email" : "aaron.riccitelli@medecision.com" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "YZ1478", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "Order with Shipping Address" : { "value" : { "customerOrderNumber" : "SWAGGER-03", "endCustomerOrderNumber" : "ENDUSER1", "notes" : "Order with Shipping Address", "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US", "phoneNumber" : "987654321", "email" : "testing@yaho.com" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ] } }, "All Distributions ShipComplete-SplitOrder" : { "value" : { "customerOrderNumber" : "newcustomerP1O6", "notes" : "this is a Ship Complete Order", "acceptBackOrder" : "true", "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 10 }, { "customerLineNumber" : "2", "ingramPartNumber" : "RQ6000", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" } ], "shipmentDetails" : { "shipComplete" : "E" } } }, "APPLE DEP Sample" : { "value" : { "customerOrderNumber" : "APPLE DEP-01", "notes" : "this is APPLE DEP sample", "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "quantity" : 10 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" }, { "attributeName" : "eudepid", "attributeValue" : "DepIDTest1" }, { "attributeName" : "depordernbr", "attributeValue" : "Test1" } ] } }, "Order with CPN - SAP" : { "value" : { "customerOrderNumber" : "Order with CPN-SAP", "lines" : [ { "customerLineNumber" : "2", "customerPartNumber" : "90NB0GI4-M03110", "quantity" : 1 } ] } }, "Warranty order sample" : { "value" : { "customerOrderNumber" : "Warranty-01", "endCustomerOrderNumber" : "Warranty-01", "notes" : "Multiple Line items with Hardware and Warranty links", "resellerInfo" : { "companyName" : "Dummy", "email" : "dummy.email@ingrammicro.co.in" }, "vmf" : { "vendAuthNumber" : "MJDVATC10001A" }, "lines" : [ { "customerLineNumber" : "001", "ingramPartNumber" : "9VL970", "quantity" : 2, "additionalAttributes" : [ { "attributeName" : "SHIPFROMWAREHOUSEID", "attributeValue" : "10" } ], "warrantyInfo" : [ { "directLineLink" : "MJDVATC10001B" } ] }, { "customerLineNumber" : "002", "ingramPartNumber" : "8RB884", "quantity" : 2, "additionalAttributes" : [ { "attributeName" : "SHIPFROMWAREHOUSEID", "attributeValue" : "10" } ], "warrantyInfo" : [ { "warrantyLineLink" : "005" } ] }, { "customerLineNumber" : "003", "ingramPartNumber" : "8RB881", "quantity" : 3, "additionalAttributes" : [ { "attributeName" : "SHIPFROMWAREHOUSEID", "attributeValue" : "40" } ], "warrantyInfo" : [ { "warrantyLineLink" : "006" } ] }, { "customerLineNumber" : "004", "ingramPartNumber" : "9YG948", "quantity" : 2, "additionalAttributes" : [ { "attributeName" : "SHIPFROMWAREHOUSEID", "attributeValue" : "49" } ], "endUserInfo" : [ { "endUserId" : "5", "addressSequenceNumber" : "1", "contactId" : "1", "contact" : "Dummy John", "phoneNumber" : "78776777771", "email" : "dummy.email1@ingrammicro.co.in" } ], "warrantyInfo" : [ { "directLineLink" : "MJDVATC10001B" } ] }, { "customerLineNumber" : "005", "ingramPartNumber" : "9HG002", "quantity" : 1, "additionalAttributes" : [ { "attributeName" : "SHIPFROMWAREHOUSEID", "attributeValue" : "49" } ], "endUserInfo" : [ { "endUserId" : "5", "addressSequenceNumber" : "1", "contactId" : "1", "contact" : "Dummy John", "phoneNumber" : "78776777771", "email" : "dummy.email1@ingrammicro.co.in" } ], "warrantyInfo" : [ { "hardwareLineLink" : "002" } ] }, { "customerLineNumber" : "006", "ingramPartNumber" : "9HF999", "quantity" : 3, "additionalAttributes" : [ { "attributeName" : "SHIPFROMWAREHOUSEID", "attributeValue" : "49" } ], "endUserInfo" : [ { "endUserId" : "5", "addressSequenceNumber" : "1", "contactId" : "1", "contact" : "Dummy John", "phoneNumber" : "78776777771", "email" : "dummy.email1@ingrammicro.co.in" } ], "warrantyInfo" : [ { "hardwareLineLink" : "003" } ] } ], "additionalAttributes" : [ { "attributeName" : "enableCommentsAsLines", "attributeValue" : "true" }, { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" }, { "attributeName" : "allowOrderOnCustomerHold", "attributeValue" : "false" } ] } }, "Govt fields with End User Info" : { "value" : { "customerOrderNumber" : "GovtOrder-01", "endCustomerOrderNumber" : "EPK_01081841", "endUserInfo" : { "companyName" : "US AIR FORCEE", "addressLine1" : "14300 FANG DR", "city" : "JACKSONVILLE", "state" : "FL", "postalCode" : "322187933", "countryCode" : "US", "phoneNumber" : "4786620376", "email" : "MATT.DIXON@US.AF.MIL" }, "lines" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "4A0036", "quantity" : "1,", "unitPrice" : 41.71 } ], "additionalAttributes" : [ { "attributeName" : "allowDuplicateCustomerOrderNumber", "attributeValue" : "true" }, { "attributeName" : "govtProgramType", "attributeValue" : "PA" }, { "attributeName" : "govtEndUserType", "attributeValue" : "F" }, { "attributeName" : "govtSolicitationNumber", "attributeValue" : "438" }, { "attributeName" : "govtEndUserData", "attributeValue" : "US AIR FORCEE" }, { "attributeName" : "govtEndUserPostalCode", "attributeValue" : "322187933" }, { "attributeName" : "govtPublicPrivateCode", "attributeValue" : "P" } ] } } }, "schema" : { "$ref" : "#/components/schemas/OrderCreateRequest" } } }, "required" : true }, "responses" : { "201" : { "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "description" : "Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderCreateResponse" }, "examples" : { "Order with Header Comments Response" : { "value" : { "customerOrderNumber" : "SWAGGER-01", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 14.29, "resellerInfo" : { }, "shipToInfo" : { "addressId" : "200", "companyName" : "INGRAM MICRO TEST ACCOUNT", "addressLine1" : "ATTN TOD DEBIE", "addressLine2" : "1610 E SAINT ANDREW PL", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFKW4", "ingramOrderDate" : "2021-05-26", "notes" : "", "orderType" : "S", "orderTotal" : 14.29, "freightCharges" : 14.29, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFKW4-11", "ingramLineNumber" : "001", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "O1", "carrierName" : "ONTRAC", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFKW4", "type" : "GET" } ] } ] } }, "Order on customer Hold" : { "value" : { "customerOrderNumber" : "SWAGGER-01", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 0, "resellerInfo" : { }, "shipToInfo" : { "addressId" : "200", "companyName" : "INGRAM MICRO TEST ACCOUNT", "addressLine1" : "ATTN TOD DEBIE", "addressLine2" : "1610 E SAINT ANDREW PL", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFKWQ", "ingramOrderDate" : "2021-05-26", "notes" : "CUSTOMERHOLDORDERSAMPLE", "orderType" : "S", "orderTotal" : 0, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFKWQ-11", "ingramLineNumber" : "002", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "XC", "carrierName" : "RG 3001 ND", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFKWQ", "type" : "GET" } ] } ] } }, "Ship Complete Order Response" : { "value" : { "customerOrderNumber" : "THIS_IS-12", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 70.84, "resellerInfo" : { }, "shipToInfo" : { "addressId" : "200", "companyName" : "INGRAM MICRO TEST ACCOUNT", "addressLine1" : "ATTN TOD DEBIE", "addressLine2" : "1610 E SAINT ANDREW PL", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFJN3", "ingramOrderDate" : "2021-05-13", "notes" : "////ORDER HEADER", "orderType" : "D", "orderTotal" : 70.84, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFJN3-11", "ingramLineNumber" : "002", "customerLineNumber" : "1", "lineStatus" : "In Progress", "ingramPartNumber" : "4U0212", "unitPrice" : 70.84, "extendedUnitPrice" : 70.84, "quantityOrdered" : 1, "quantityConfirmed" : 1, "quantityBackOrdered" : 0, "notes" : "3YR NBD EXCH SJ PRO 3XXX SVC SVCS", "shipmentDetails" : { "carrierCode" : "VL", "carrierName" : "VIRTUAL", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFJN3", "type" : "GET" } ] } ] } }, "Backordered response" : { "value" : { "customerOrderNumber" : "NEWCUSTOMERP1O6", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 7.83, "resellerInfo" : { }, "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFKWP", "ingramOrderDate" : "2021-05-26", "notes" : "", "orderType" : "S", "orderTotal" : 7.83, "freightCharges" : 7.83, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFKWP-11", "ingramLineNumber" : "002", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "4M", "carrierName" : "SMARTPOST-BM", "shipFromWarehouseId" : "30", "shipFromLocation" : "Millington, TN" } } ], "miscellaneousCharges" : [ { "subOrderNumber" : "20-RFKWP-11", "chargeLineReference" : "895", "chargeDescription" : "FREE FREIGHT", "chargeAmount" : 0 } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFKWP", "type" : "GET" } ] } ] } }, "Shipping Instruction and Signature Required" : { "value" : { "customerOrderNumber" : "SHIPVIAEG", "billToAddressId" : "20-RFKKT : 000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 70.84, "resellerInfo" : { }, "shipToInfo" : { "addressId" : "20-RFKKT : 200", "companyName" : "INGRAM MICRO TEST ACCOUNT", "addressLine1" : "ATTN TOD DEBIE", "addressLine2" : "1610 E SAINT ANDREW PL", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFKKT", "ingramOrderDate" : "2021-05-24", "notes" : "20-RFKKT : ///SHPI:THIS IS THE SHIPPING INSTRU || 20-RFKKT : ///SHPI:CTION FOR THIS ORDER", "orderType" : "D", "orderTotal" : 70.84, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "20-RFKKT : USD", "lines" : [ { "subOrderNumber" : "20-RFKKT-11", "ingramLineNumber" : "003", "customerLineNumber" : "1", "lineStatus" : "In Progress", "ingramPartNumber" : "4U0212", "unitPrice" : 70.84, "extendedUnitPrice" : 70.84, "quantityOrdered" : 1, "quantityConfirmed" : 1, "quantityBackOrdered" : 0, "notes" : "3YR NBD EXCH SJ PRO 3XXX SVC SVCS", "shipmentDetails" : { "carrierCode" : "VL", "carrierName" : "VIRTUAL", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA", "signatureRequired" : "true", "shippingInstructions" : "This is the shipping instruction for this order" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFKKT", "type" : "GET" } ] } ] } }, "Carrier Code & Fright Account Number Response" : { "value" : { "customerOrderNumber" : "SPCLBID1", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 9.54, "resellerInfo" : { }, "shipToInfo" : { "addressId" : "200", "companyName" : "INGRAM MICRO TEST ACCOUNT", "addressLine1" : "ATTN TOD DEBIE", "addressLine2" : "1610 E SAINT ANDREW PL", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFK3K", "ingramOrderDate" : "2021-05-21", "notes" : "TESTING MAULTIPLE LINE ITEMS", "orderType" : "S", "orderTotal" : 9.54, "freightCharges" : 9.54, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFK3K-11", "ingramLineNumber" : "002", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "RG", "carrierName" : "FEDEX GROUND", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA", "freightAccountNumber" : "FRT100" } } ], "miscellaneousCharges" : [ { "subOrderNumber" : "20-RFK3K-11", "chargeLineReference" : "895", "chargeDescription" : "FREE FREIGHT", "chargeAmount" : 0 } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFK3K", "type" : "GET" } ] } ] } }, "Response with Shipping Address" : { "value" : { "customerOrderNumber" : "TESTING_APR07", "endCustomerOrderNumber" : "ENDUSER", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 0, "resellerInfo" : { "companyName" : "Demo" }, "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US", "phoneNumber" : "987654321", "email" : "testing@yaho.com" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFDMQ", "ingramOrderDate" : "2021-04-07", "notes" : "", "orderType" : "S", "orderTotal" : 7.13, "freightCharges" : 7.13, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFDMQ-11", "ingramLineNumber" : "001", "customerLineNumber" : "1", "lineStatus" : "im::backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "4M", "carrierName" : "SMARTPOST-BM", "shipFromWarehouseId" : "30", "shipFromLocation" : "Millington, TN" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6.1/orders/20-RFDMQ", "type" : "GET" } ] } ] } }, "Direct Ship with EndUser Info" : { "value" : { "customerOrderNumber" : "SWAGGER-03", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 2802.71, "resellerInfo" : { }, "shipToInfo" : { "contact" : "CUSTOMER 1", "companyName" : "ABC PRIAVTE LTD", "addressLine1" : "7001 SW 24TH AVE", "addressLine2" : "TESTING", "city" : "GAINESVILLE", "state" : "FL", "postalCode" : "326073704", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFJYX", "ingramOrderDate" : "2021-05-20", "notes" : "This is enduser info Order", "orderType" : "D", "orderTotal" : 2802.71, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFJYX-11", "ingramLineNumber" : "002", "customerLineNumber" : "1", "lineStatus" : "In Progress", "ingramPartNumber" : "YZ1478", "unitPrice" : 2802.71, "extendedUnitPrice" : 2802.71, "quantityOrdered" : 1, "quantityConfirmed" : 1, "quantityBackOrdered" : 0, "notes" : "PROD SNS VSPHERE 6 ESSLPL KIT SLIC || 3YR || EU#- 000418285 MEDIA3 TECHNOLOGIES || MC# C", "shipmentDetails" : { "carrierCode" : "VL", "carrierName" : "VIRTUAL", "shipFromWarehouseId" : "40", "shipFromLocation" : "Carol Stream, IL" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFJYX", "type" : "GET" } ] } ] } }, "Combined Order(Stock + Direct Ship)" : { "value" : { "customerOrderNumber" : "TEJAL899", "endCustomerOrderNumber" : "ENDUSER", "billToAddressId" : "000000", "orderSplit" : true, "processedPartially" : false, "purchaseOrderTotal" : 34212.93, "resellerInfo" : { }, "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFKM1", "ingramOrderDate" : "2021-05-25", "notes" : "", "orderType" : "S", "orderTotal" : 7.83, "freightCharges" : 7.83, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFKM1-11", "ingramLineNumber" : "001", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "4M", "carrierName" : "SMARTPOST-BM", "shipFromWarehouseId" : "30", "shipFromLocation" : "Millington, TN" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFKM1", "type" : "GET" } ] }, { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFKM2", "ingramOrderDate" : "2021-05-25", "notes" : "////ORDER HEADER", "orderType" : "D", "orderTotal" : 34205.1, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFKM2-11", "ingramLineNumber" : "002", "customerLineNumber" : "2", "lineStatus" : "In Progress", "ingramPartNumber" : "RQ6000", "unitPrice" : 34205.1, "extendedUnitPrice" : 34205.1, "quantityOrdered" : 1, "quantityConfirmed" : 1, "quantityBackOrdered" : 0, "notes" : "TIERBEAST 2CTRL 8GB 14X600GB PERP || SAS 28X1TB SATA BLACK", "shipmentDetails" : { "carrierCode" : "XC", "carrierName" : "GR 127050 UN", "shipFromWarehouseId" : "40", "shipFromLocation" : "Carol Stream, IL" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFKM2", "type" : "GET" } ] } ] } }, "Ship from warehouseid Response" : { "value" : { "customerOrderNumber" : "NEWCUSTOMERPO4", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 14.29, "resellerInfo" : { }, "shipToInfo" : { "addressId" : "200", "companyName" : "INGRAM MICRO TEST ACCOUNT", "addressLine1" : "ATTN TOD DEBIE", "addressLine2" : "1610 E SAINT ANDREW PL", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFKTB", "ingramOrderDate" : "2021-05-25", "notes" : "", "orderType" : "S", "orderTotal" : 14.29, "freightCharges" : 14.29, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFKTB-11", "ingramLineNumber" : "003", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "O1", "carrierName" : "ONTRAC", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA" } } ], "miscellaneousCharges" : [ { "subOrderNumber" : "20-RFKTB-11", "chargeLineReference" : "895", "chargeDescription" : "FREE FREIGHT", "chargeAmount" : 0 } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFKTB", "type" : "GET" } ] } ] } }, "Order Split Response" : { "value" : { "customerOrderNumber" : "TEJAL899", "endCustomerOrderNumber" : "ENDUSER", "billToAddressId" : "000", "orderSplit" : true, "processedPartially" : false, "purchaseOrderTotal" : 36445.03, "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "50-65931", "ingramOrderDate" : "2021-03-31", "notes" : "////ORDER HEADER", "orderType" : "S", "orderTotal" : 0, "freightCharges" : 9.03, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "50-65931-11", "ingramLineNumber" : "001", "customerLineNumber" : "1", "lineStatus" : "im::backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 69.51, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "RG", "carrierName" : "FEDEX GROUND", "shipFromWarehouseId" : "30", "shipFromLocation" : "Millington, TN" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6.1/orders/50-65931", "type" : "GET" } ] }, { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "50-65932", "ingramOrderDate" : "2021-03-31", "notes" : "////ORDER HEADER", "orderType" : "D", "orderTotal" : 36436, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "50-65932-11", "ingramLineNumber" : "002", "customerLineNumber" : "1", "lineStatus" : "im::open", "ingramPartNumber" : "RQ6000", "unitPrice" : 36436, "quantityOrdered" : 1, "quantityConfirmed" : 1, "quantityBackOrdered" : 0, "notes" : "TIERBEAST 2CTRL 8GB 14X600GB PERP || SAS 28X1TB SATA BLACK", "shipmentDetails" : { "carrierCode" : "GR", "carrierName" : "DR SHP GROUN", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v5/orders/50-65932", "type" : "GET" } ] } ] } }, "Price Variance Response" : { "value" : { "customerOrderNumber" : "PRICEVARIANCE", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 9.54, "resellerInfo" : { }, "shipToInfo" : { "companyName" : "B2B_TESTING_DEV", "addressLine1" : "100 LIGHTING WAY, 3RD FLOOR", "city" : "SECAUCUS", "state" : "NJ", "postalCode" : 70940000, "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-B31TK", "ingramOrderDate" : "2021-05-20", "notes" : "", "orderType" : "S", "orderTotal" : 9.54, "freightCharges" : 9.54, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-B31TK-11", "ingramLineNumber" : "001", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "TSXML1", "unitPrice" : 7.15, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "TEST XML SKU WITH NO AVAILABLE CABL || STOCK", "shipmentDetails" : { "carrierCode" : "RG", "carrierName" : "FEDEX GROUND", "shipFromWarehouseId" : "80", "shipFromLocation" : "Jonestown, PA" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-B31TK", "type" : "GET" } ] } ] } }, "All Distributions ShipComplete-SplitOrder" : { "value" : { "customerOrderNumber" : "NEWCUSTOMERP1O6", "billToAddressId" : "000", "orderSplit" : true, "processedPartially" : false, "purchaseOrderTotal" : 34212.93, "resellerInfo" : { }, "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFL62", "ingramOrderDate" : "2021-05-28", "notes" : "THIS IS A SHIP COMPLETE ORDER", "orderType" : "S", "orderTotal" : 7.83, "freightCharges" : 7.83, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFL62-11", "ingramLineNumber" : "002", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 10, "quantityConfirmed" : 0, "quantityBackOrdered" : 10, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "4M", "carrierName" : "SMARTPOST-BM", "shipFromWarehouseId" : "30", "shipFromLocation" : "Millington, TN" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFL62", "type" : "GET" } ] }, { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFL63", "ingramOrderDate" : "2021-05-28", "notes" : "THIS IS BACKORDER SAMPLE", "orderType" : "D", "orderTotal" : 34205.1, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFL63-11", "ingramLineNumber" : "002", "customerLineNumber" : "2", "lineStatus" : "In Progress", "ingramPartNumber" : "RQ6000", "unitPrice" : 34205.1, "extendedUnitPrice" : 34205.1, "quantityOrdered" : 1, "quantityConfirmed" : 1, "quantityBackOrdered" : 0, "notes" : "TIERBEAST 2CTRL 8GB 14X600GB PERP || SAS 28X1TB SATA BLACK", "shipmentDetails" : { "carrierCode" : "XC", "carrierName" : "GR 127050 UN", "shipFromWarehouseId" : "40", "shipFromLocation" : "Carol Stream, IL" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFL63", "type" : "GET" } ] } ] } }, "APPLE DEP Response" : { "value" : { "customerOrderNumber" : "APPLE DEP-01", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 14.29, "resellerInfo" : { }, "shipToInfo" : { "addressId" : "200", "companyName" : "INGRAM MICRO TEST ACCOUNT", "addressLine1" : "ATTN TOD DEBIE", "addressLine2" : "1610 E SAINT ANDREW PL", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFLV4", "ingramOrderDate" : "2021-06-03", "notes" : "THIS IS APPLE DEP SAMPLE", "orderType" : "S", "orderTotal" : 14.29, "freightCharges" : 14.29, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFLV4-11", "ingramLineNumber" : "002", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 10, "quantityConfirmed" : 0, "quantityBackOrdered" : 10, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "O1", "carrierName" : "ONTRAC", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFLV4", "type" : "GET" } ] } ] } }, "Order with CPN Response-SAP" : { "value" : { "customerOrderNumber" : "Order with CPN-SAP", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 5, "resellerInfo" : { }, "shipToInfo" : { "addressId" : "292711", "companyName" : "ASUS ONLINE STORE", "addressLine1" : "205 KALLANG BAHRU, 04-00", "city" : "SINGAPORE", "state" : "SG", "postalCode" : "339341", "countryCode" : "SG" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "7059827143", "ingramOrderDate" : "2021-06-03T18:37:08+08:00", "notes" : "", "orderType" : "ZOR", "orderTotal" : 5, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "SGD", "lines" : [ { "ingramLineNumber" : "10", "customerLineNumber" : "2", "lineStatus" : "Backordered", "ingramPartNumber" : "4008025", "unitPrice" : 2218, "extendedUnitPrice" : 2218, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "shipmentDetails" : { "carrierCode" : "FR1SG00030", "shipFromWarehouseId" : "SG01" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/7059827143", "type" : "GET" } ] } ] } }, "Warranty Order Response" : { "value" : { "customerOrderNumber" : "MJD114TC1041A", "endCustomerOrderNumber" : "MJD114TC1041A", "billToAddressId" : "000", "orderSplit" : true, "processedPartially" : false, "purchaseOrderTotal" : 17577.08, "resellerInfo" : { "companyName" : "Dummy", "email" : "dummy.email@ingrammicro.co.in" }, "shipToInfo" : { }, "orders" : [ { "numberOfLinesWithSuccess" : 5, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-99999", "ingramOrderDate" : "2022-04-11", "orderType" : "S", "orderTotal" : 6147.92, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-99999-31", "ingramLineNumber" : "001", "customerLineNumber" : "002", "lineStatus" : "In Progress", "globalSkuId" : "A300-8RB884", "ingramPartNumber" : "8RB884", "vendorPartNumber" : "MYD82LL/A", "unitPrice" : 1258.33, "extendedUnitPrice" : 2516.66, "quantityOrdered" : 2, "quantityConfirmed" : 2, "quantityBackOrdered" : 0, "notes" : "MACBOOK PRO 13IN M1 256GB SG SYST || 8-CORE CPU 8-CORE GPU", "shipmentDetails" : { "carrierCode" : "RG", "carrierName" : "FEDEX GROUND", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA" } }, { "subOrderNumber" : "20-99999-11", "ingramLineNumber" : "002", "customerLineNumber" : "003", "lineStatus" : "In Progress", "globalSkuId" : "A300-8RB881", "ingramPartNumber" : "8RB881", "vendorPartNumber" : "MGN73LL/A", "unitPrice" : 1210.42, "extendedUnitPrice" : 3631.26, "quantityOrdered" : 3, "quantityConfirmed" : 3, "quantityBackOrdered" : 0, "notes" : "MACBOOK AIR 13IN M1 512GB SG SYST || 8-CORE CPU 8-CORE GPU", "shipmentDetails" : { "carrierCode" : "FC", "carrierName" : "FOX HOURLY", "shipFromWarehouseId" : "40", "shipFromLocation" : "Carol Stream, IL" } }, { "subOrderNumber" : "20-99999-21", "ingramLineNumber" : "003", "customerLineNumber" : "004", "lineStatus" : "Backordered", "globalSkuId" : "A300-9YG948", "ingramPartNumber" : "9YG948", "vendorPartNumber" : "SCPG2LL/A", "unitPrice" : 203.13, "extendedUnitPrice" : 0, "quantityOrdered" : 2, "quantityConfirmed" : 0, "quantityBackOrdered" : 2, "notes" : "APPLECARE+ 14IN MACBOOK PRO SVCS || EU#- 009999999 TEST END USER || MC# C || EUSR CONT:DUMMY JOHN || EUSR EMAL:DUMMY.EMAIL1@INGRAMMICRO.CO.IN", "shipmentDetails" : { "carrierCode" : "Q5", "carrierName" : "OUT SOURCE S", "shipFromWarehouseId" : "49", "shipFromLocation" : "Electronic Download" } }, { "subOrderNumber" : "20-99999-21", "ingramLineNumber" : "004", "customerLineNumber" : "005", "lineStatus" : "Backordered", "globalSkuId" : "A300-9HG002", "ingramPartNumber" : "9HG002", "vendorPartNumber" : "S9736LL/A ", "unitPrice" : 181.25, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "APPLECARE+ FOR 13-INCH MACBOOK DOWN || PRO M1 || EU#- 009999999 TEST END USER || MC# C || EUSR CONT:DUMMY JOHN || EUSR EMAL:DUMMY.EMAIL1@INGRAMMICRO.CO.IN", "shipmentDetails" : { "carrierCode" : "Q5", "carrierName" : "OUT SOURCE S", "shipFromWarehouseId" : "49", "shipFromLocation" : "Electronic Download" } }, { "subOrderNumber" : "20-99999-21", "ingramLineNumber" : "005", "customerLineNumber" : "006", "lineStatus" : "Backordered", "globalSkuId" : "A300-9HF999", "ingramPartNumber" : "9HF999", "vendorPartNumber" : "S9788LL/A", "unitPrice" : 144.79, "extendedUnitPrice" : 0, "quantityOrdered" : 3, "quantityConfirmed" : 0, "quantityBackOrdered" : 3, "notes" : "APPLECARE+ FOR MACBOOK AIR DOWN || EU#- 009999999 TEST END USER || MC# C || EUSR CONT:DUMMY JOHN || EUSR EMAL:DUMMY.EMAIL1@INGRAMMICRO.CO.IN", "shipmentDetails" : { "carrierCode" : "Q5", "carrierName" : "OUT SOURCE S", "shipFromWarehouseId" : "49", "shipFromLocation" : "Electronic Download" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-99999", "type" : "GET" } ] }, { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-99998", "ingramOrderDate" : "2022-04-11", "orderType" : "D", "orderTotal" : 11429.16, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-99998-11", "ingramLineNumber" : "002", "customerLineNumber" : "001", "lineStatus" : "In Progress", "globalSkuId" : "A300-9VL970", "ingramPartNumber" : "9VL970", "vendorPartNumber" : "Z15G001XM", "unitPrice" : 5714.58, "extendedUnitPrice" : 11429.16, "quantityOrdered" : 2, "quantityConfirmed" : 2, "quantityBackOrdered" : 0, "notes" : "CTO 14IN MACBOOK PRO M1 MAX SYST || 10C CPU 32C GPU 64GB 8TB SP GRAY", "shipmentDetails" : { "carrierCode" : "GR", "carrierName" : "DR SHP GROUN", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-99998", "type" : "GET" } ] } ] } }, "Govt fields with End User Info" : { "value" : { "customerOrderNumber" : "GovtOrder-01", "endCustomerOrderNumber" : "EPK_01081841", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 41.71, "resellerInfo" : { }, "shipToInfo" : { }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-B31TK", "ingramOrderDate" : "2021-05-20", "notes" : "EUNAME: US AIR FORCEE || EUADD1: 14300 FANG DR || EUPH: 4786620376 || EUEMAIL: MATT.DIXON@US.AF.MIL", "orderType" : "S", "orderTotal" : 41.71, "freightCharges" : 0, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-B31TK-11", "ingramLineNumber" : "001", "customerLineNumber" : "1", "lineStatus" : "Backordered", "globalSkuId" : "A300-4A0036", "ingramPartNumber" : "4A0036", "vendorPartNumber" : "E2016HV", "vendorNumber" : "802U", "unitPrice" : 41.71, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "20IN MONITOR E2016HV 210-AGLU MNTR || EU#- 010004087 US AIR FORCEE || MC# F", "shipmentDetails" : { "carrierCode" : "UG", "carrierName" : "UPS GROUND", "shipFromWarehouseId" : "40", "shipFromLocation" : "Carol Stream, IL" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-B31TK", "type" : "GET" } ] } ] } } } } } }, "207" : { "description" : "Multi-Status", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderCreateResponse" }, "examples" : { "Partial Success" : { "value" : { "customerOrderNumber" : "TESTING_APR08", "endCustomerOrderNumber" : "ENDUSER", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : false, "purchaseOrderTotal" : 0, "resellerInfo" : { "companyName" : "Demo" }, "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 0, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFDMQ", "ingramOrderDate" : "2021-04-07", "notes" : "", "orderType" : "S", "orderTotal" : 7.13, "freightCharges" : 7.13, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFDMR-11", "ingramLineNumber" : "001", "customerLineNumber" : "1", "lineStatus" : "im::backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "4M", "carrierName" : "SMARTPOST-BM", "shipFromWarehouseId" : "30", "shipFromLocation" : "Millington, TN" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6.1/orders/20-RFDMQ", "type" : "GET" } ], "rejectedLineItems" : [ { "customerLinenumber" : "1", "ingramPartNumber" : "DF4128MW", "quantityOrdered" : 1, "rejectCode" : "EN", "rejectReason" : "SKU-NOTFOUND DF4128MW" } ] } ] } }, "Partial Order and special bid Number" : { "value" : { "customerOrderNumber" : "NEWCUSTOMERPO4", "billToAddressId" : "000", "orderSplit" : false, "processedPartially" : true, "purchaseOrderTotal" : 7.83, "resellerInfo" : { "companyName" : "Demo" }, "shipToInfo" : { "contact" : "TOM SORENSEN", "companyName" : "FIRST NATIONAL BANK OF OMAHA", "addressLine1" : "17501 W 98TH ST SPC 1833", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US" }, "orders" : [ { "numberOfLinesWithSuccess" : 1, "numberOfLinesWithError" : 1, "numberOfLinesWithWarning" : 0, "ingramOrderNumber" : "20-RFJYP", "ingramOrderDate" : "2021-05-20", "notes" : "", "orderType" : "S", "orderTotal" : 7.83, "freightCharges" : 7.83, "totalTax" : 0, "currencyCode" : "USD", "lines" : [ { "subOrderNumber" : "20-RFJYP-11", "ingramLineNumber" : "001", "customerLineNumber" : "1", "lineStatus" : "Backordered", "ingramPartNumber" : "DF4128", "unitPrice" : 61.22, "extendedUnitPrice" : 0, "quantityOrdered" : 1, "quantityConfirmed" : 0, "quantityBackOrdered" : 1, "notes" : "COMBO WAVE MK550 WRLS DESKTOP WRLS || WRLS LASER MOUSE", "shipmentDetails" : { "carrierCode" : "4M", "carrierName" : "SMARTPOST-BM", "shipFromWarehouseId" : "30", "shipFromLocation" : "Millington, TN" } } ], "links" : [ { "topic" : "orders", "href" : "/resellers/v6/orders/20-RFJYP", "type" : "GET" } ], "rejectedLineItems" : [ { "customerLinenumber" : "1", "ingramPartNumber" : "XXXXXX", "quantityOrdered" : 1, "rejectCode" : "EN", "rejectReason" : "SKU-NOTFOUND XXXXXX" } ] } ] } } } } } }, "400" : { "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Error" : { "value" : { "errors" : [ { "id" : "123-345-678-bw0a1077-2021-04-07T01:26:54.411-07:00", "type" : "/errors/validation-failed", "messaage" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "USA", "message" : "IM-CountryCode is not valid" } ] } ] } } } } } }, "500" : { "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "C123-bw0a10u3-2021-02-19T11:12:26.436-08:00", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred, please contact support team for more details" } ] } } } } } } } } }, "/resellers/v7/orders": { "post": { "summary": "Order Create v7 Overview", "tags": [ "Orders v7" ], "description": "The Order Create v7 API allows customers to create orders asynchronously. It supports:\n\n- Standard orders using stocked SKUs from the traditional catalog and cloud catalog\n- Quote to Order (QTO) using an existing quote in Ready to Order status\n- Configure to Order (CTO) orders based on an approved CTO quote\n\nAfter a valid request is submitted, the API returns an acknowledgment confirming that the order request has been accepted for processing. Final order updates are then provided asynchronously, typically through webhooks.\n\n---\n\n## Quote to Order / Configure to Order\n\nFor Quote to Order and Configure to Order flows, customers should first validate the quote using the Vendor Required Info (VRI) API before submitting the order.\n\nThe VRI API helps by:\n\n- Validating the quote for ordering\n- Identifying vendor-mandated fields required at both the header and line level\n- Showing exactly which values must be included in the order payload\n\n## Recommended QTO / CTO Flow\n\n1. Submit the quote number to the Vendor Required Info API.\n2. Review the required fields returned by the API.\n3. Include all required vendor fields and values in the order request.\n4. Submit the order creation request.\n5. Track downstream status updates through webhook notifications.\n\n## Cloud Ordering\n\nFor new cloud subscription orders, customers should use the Vendor Required Info (VRI) API before calling Order Create v7. This is an important step because cloud vendors often require vendor-specific mandatory fields that vary by plan and vendor.\n\n## Recommended Cloud Ordering Flow\n\n1. Use Product Details to retrieve the correct product identifiers, such as `planId`, `vpn`, and `resourceId`.\n2. Call Vendor Required Info (VRI) using the `planId` to identify all vendor-mandated fields required for that cloud order.\n3. Build the Order Create v7 request with:\n - Cloud plan and resource details\n - End-customer information\n - Subscription period\n - Billing period\n - All required vendor-specific fields\n4. Populate vendor-required values in `vriAdditionalAttributes` exactly as returned by VRI.\n5. Submit the order request.\n\nIf validation succeeds, the API returns an acknowledgment number and the cloud order continues processing asynchronously. Once provisioning is complete, a webhook notification is sent with the resulting order and subscription details. If validation fails, you will receive an error messaging indicating a reason and what might need to be adjusted. ## Warranty Linkage The Order Create v7 API enables customers to perform warranty linkage for hardware assets. The solution supports both automated warranty association and manual assignment using serial numbers or historical order references. **Applicable Vendors:** Apple, Dell, Microsoft --- ## Recommended Warranty Flow ## 1. Autolink (Automated Warranty Linking) When Autolink is enabled, customers must be advised of a potential Reseller PO mismatch, as the system-selected warranty may differ from the originally intended warranty.\n\n **Attribute Details:** - **Data Type:** Boolean - **Allowed Values:** `true` / `false` - **Default Value:** `false` \n\n **Autolink Behavior:** - When Autolink is set to `true`, the system automatically identifies and associates the first compatible warranty available with the corresponding hardware SKU. - The associated warranty details are included in the response returned to the customer. \n\n User Advisory:**\n\n- When Autolink is enabled, customers must be advised of a potential Reseller PO mismatch, as the system-selected warranty may differ from the originally intended warranty.\n- Any automatically linked warranty will be added to the order, billed accordingly, and reflected on the invoice. --- ## 2. Linking Through Serial Number (Manual Linking) Users can manually establish a relationship between a warranty SKU and its corresponding hardware SKU. - If **both hardware and warranty SKUs** are included in the same request, customers must provide: - `hardwareLineLink` **or** - `warrantyLineLink` - If **only the warranty SKU** is included in the request, customers must provide: - Hardware Serial Number - Date of Purchase (within the vendor-defined grace period) **Grace Period:** - A vendor-defined time window during which a customer is permitted to associate a warranty with previously purchased hardware. --- ## 3. Linking Through Historical Purchased Orders Customers can establish warranty linkage by referencing a valid historical Ingram order number. - Provide order details for hardware purchased within the vendor-defined grace period.", "operationId": "post-createorder_v7", "security": [ { "application": [ "read" ] } ], "parameters": [ { "name": "IM-CustomerNumber", "in": "header", "description": "Your unique Ingram Micro customer number.", "required": true, "schema": { "type": "string", "maxLength": 10, "example": "20-222222" } }, { "name": "IM-CountryCode", "in": "header", "description": "Two-character ISO country code.", "required": true, "schema": { "type": "string", "maxLength": 2, "minLength": 2, "example": "US" } }, { "name": "IM-SenderID", "in": "header", "description": "Unique value used to identify the sender of the transaction. Example: MyCompany", "required": false, "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" } }, { "name": "IM-CorrelationID", "in": "header", "description": "Unique transaction number to identify each transaction across all the systems.", "required": true, "schema": { "type": "string", "maxLength": 32, "example": "fbac82ba-cf0a-4bcf-fc03-0c5084" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_create_v7_request" } } }, "required": true }, "responses": { "200": { "description": "Confirmation response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateV7Response201" }, "examples": { "Success Response": { "description": "", "value": { "quoteNumber": "", "confirmationNumber": "US-I-T-24032926562341102332", "message": "Thank you for submitting the order request, it’s currently under process.We will notify you of the status via the Order Status webhook." } }, "Webhook Response" : { "value" : [ { "topic": "resellers/orders", "event": "IM::created", "eventTimeStamp": "2024-04-23T15:03:11.267Z", "eventId": "NYNNHS5UMGAK0X3L4E", "resource": { "eventType": "IM::async_order_create", "customerOrderNumber": "TESTCASE41E111", "endCustomerOrderNumber": "X4D_TT", "billToAddressId": "000", "orderSplit": false, "processedPartially": false, "purchaseOrderTotal": 0.0, "resellerInfo": { "companyName": "INGRAM MICRO TEST CUSTOMER", "contact": " ", "addressLine1": "CL. CANTABRIA, 2 3 PLTA. MOD. B1", "addressLine2": "EDF. AMURA", "addressLine3": "", "city": "ALCOBENDAS MADRID", "state": "ES", "postalCode": "28108", "countryCode": "ES", "phoneNumber": "934749090", "email": "IN-Endeavour.Auto@ingrammicro.com" }, "shipToInfo": { "addressId": "200", "companyName": "INGRAM MICRO TEST ACCOUNT", "addressLine1": "ATTN TOD DEBIE", "addressLine2": "1610 E SAINT ANDREW PL", "city": "SANTA ANA", "state": "CA", "postalCode": "927054931", "countryCode": "US" }, "endUserInfo": { "endUserId" : "5", "addressSequenceNumber" : "1", "contactId" : "1", "contact" : "Dummy John", "phoneNumber" : "78776777771", "email" : "dummy.email1@ingrammicro.co.in" }, "orders": [ { "numberOfLinesWithSuccess": 1, "numberOfLinesWithError": 0, "numberOfLinesWithWarning": 0, "ingramOrderNumber": "29-02738", "ingramOrderDate": "2024-04-23", "notes": "EUNAME: LTIMINDTREE || EUNAME1: RASHIM SAMEER || EUADD1: C/ ANDALUCÍA 62 || EUPH: 65756756756 || UEMAIL: RASHIM.SAMEER@INGRAMMICRO.C || OM || \\\\\\EUID: 19", "orderType": "S", "orderTotal": 0.0, "freightCharges": 0.0, "totalTax": 0.0, "currencyCode": "EUR", "lines": [ { "subOrderNumber": "29-02738-11", "customerLineNumber": "001", "lineType": "P", "ingramLineNumber": "008", "globalSkuId": "A306-CD98075", "lineStatus": "Backordered", "ingramPartNumber": "CD98075", "vendorNumber": "D190", "extendedUnitPrice": 0.0, "notes": "GALAXY A33 5G EE SMD || BLACK 6+128GB || EUÑ- 000410729 LTIMINDTREE || MCÑC","unitPrice": 290.0, "quantityOrdered": 1, "quantityConfirmed": 0, "quantityBackOrdered": 1, "shipmentDetails": { "carrierCode": "GN", "carrierName": "DHL NORMAL", "shipFromWarehouseId": "29" }, "endUserInfo": { "endUserId" : "", "companyName" : "MEDECISION INC", "contact" : "AARON RICCITELLI", "addressLine1" : "601 LEE RD", "city" : "wayne", "state" : "pa", "postalCode" : "190875607", "countryCode" : "US", "phoneNumber" : "6105400202", "email" : "aaron.riccitelli@medecision.com" }, "warrantyInfo": { "directLineLink" : "MJDVATC10001B" } } ], "miscellaneousCharges": [ { "subOrderNumber": "29-02738-11", "chargeLineReference": "890", "chargeDescription": "CARGO POR PEDIDO ELECTRONIC", "chargeAmount": 0.0 } ], "links": [ { "topic": "orders", "href": "/resellers/v6/orders/29-02738", "type": "GET" } ] } ] } }] } } } } }, "201": { "description": "Webhook Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateV7Response" }, "examples": { "Webhook Response" : { "value" : [ { "topic": "resellers/orders", "event": "IM::created", "eventTimeStamp": "2024-04-23T15:03:11.267Z", "eventId": "NYNNHS5UMGAK0X3L4E", "resource": { "eventType": "IM::async_order_create", "customerOrderNumber": "TESTCASE41E111", "endCustomerOrderNumber": "X4D_TT", "billToAddressId": "000", "orderSplit": false, "processedPartially": false, "purchaseOrderTotal": 0.0, "resellerInfo": { "companyName": "INGRAM MICRO TEST CUSTOMER", "contact": " ", "addressLine1": "CL. CANTABRIA, 2 3 PLTA. MOD. B1", "addressLine2": "EDF. AMURA", "addressLine3": "", "city": "ALCOBENDAS MADRID", "state": "ES", "postalCode": "28108", "countryCode": "ES", "phoneNumber": "934749090", "email": "IN-Endeavour.Auto@ingrammicro.com" }, "shipToInfo": { "addressId": "200", "companyName": "INGRAM MICRO TEST ACCOUNT", "addressLine1": "ATTN TOD DEBIE", "addressLine2": "1610 E SAINT ANDREW PL", "city": "SANTA ANA", "state": "CA", "postalCode": "927054931", "countryCode": "US" }, "endUserInfo": { "endUserId" : "5", "addressSequenceNumber" : "1", "contactId" : "1", "contact" : "Dummy John", "phoneNumber" : "78776777771", "email" : "dummy.email1@ingrammicro.co.in" }, "orders": [ { "numberOfLinesWithSuccess": 1, "numberOfLinesWithError": 0, "numberOfLinesWithWarning": 0, "ingramOrderNumber": "29-02738", "ingramOrderDate": "2024-04-23", "notes": "EUNAME: LTIMINDTREE || EUNAME1: RASHIM SAMEER || EUADD1: C/ ANDALUCÍA 62 || EUPH: 65756756756 || UEMAIL: RASHIM.SAMEER@INGRAMMICRO.C || OM || \\\\\\EUID: 19", "orderType": "S", "orderTotal": 0.0, "freightCharges": 0.0, "totalTax": 0.0, "currencyCode": "EUR", "lines": [ { "subOrderNumber": "29-02738-11", "customerLineNumber": "001", "lineType": "P", "ingramLineNumber": "008", "globalSkuId": "A306-CD98075", "lineStatus": "Backordered", "ingramPartNumber": "CD98075", "vendorNumber": "D190", "extendedUnitPrice": 0.0, "notes": "GALAXY A33 5G EE SMD || BLACK 6+128GB || EUÑ- 000410729 LTIMINDTREE || MCÑC","unitPrice": 290.0, "quantityOrdered": 1, "quantityConfirmed": 0, "quantityBackOrdered": 1, "shipmentDetails": { "carrierCode": "GN", "carrierName": "DHL NORMAL", "shipFromWarehouseId": "29" }, "endUserInfo": { "endUserId" : "", "companyName" : "MEDECISION INC", "contact" : "AARON RICCITELLI", "addressLine1" : "601 LEE RD", "city" : "wayne", "state" : "pa", "postalCode" : "190875607", "countryCode" : "US", "phoneNumber" : "6105400202", "email" : "aaron.riccitelli@medecision.com" }, "warrantyInfo": { "directLineLink" : "MJDVATC10001B" } } ], "miscellaneousCharges": [ { "subOrderNumber": "29-02738-11", "chargeLineReference": "890", "chargeDescription": "CARGO POR PEDIDO ELECTRONIC", "chargeAmount": 0.0 } ], "links": [ { "topic": "orders", "href": "/resellers/v6/orders/29-02738", "type": "GET" } ] } ] } }] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceid": { "type": "string", "description": "A unique trace id to identify the issue." }, "type": { "type": "string", "description": "Type of the error message." }, "message": { "type": "string", "description": "A detailed error message." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Name of the field." }, "message": { "type": "string", "description": "A filed level error message." }, "value": { "type": "string", "description": "Value of the message." } } } } } }, "examples": { "400": { "description": "Bad Request", "value": { "errors": [ { "traceid": "123456", "type": "/errors/validation-failed", "message": "customer validation failed", "fields": [ { "field": "IM-CountryCode", "message": "Required field is missing", "value": null } ] } ] } } } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceid": { "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" } } } }, "examples": { "500": { "description": "Internal Server Error", "value": { "errors": [ { "traceid": "123456", "type": "/errors/system-errors", "message": "Some unexpected error occured, please contact support team for more details" } ] } } } } } } } } }, "/resellers/v6/orders/{orderNumber}" : { "put" : { "summary" : "Modify your Order", "tags" : [ "Orders" ], "description" : "The Order Modify API endpoint allows for changes to be made to an order after the order creation process as long as the order was created with the customer hold flag.\n\n* Orders can be modified within 24hrs of being placed with the customer hold flag, after 24hrs they are voided if they are not released by the customer.\n\n* Modifying orders that were placed without the customer hold flag is not possible. \n\n* The Order Modification API call cannot be used to change shipment details, such as branch or carrier.", "operationId" : "put-ordermodify", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "orderNumber", "in" : "path", "description" : "Ingram sales order number.", "required" : true, "schema" : { "type" : "string", "example" : "20-RC1RD" } }, { "name" : "actionCode", "in" : "query", "description" : "Action code to be used for order release.", "required" : false, "schema" : { "type" : "string", "example" : "release" } },{ "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } } ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderModifyRequest" }, "examples" : { "SingleLine" : { "value" : { "lines" : [ { "customerLineNumber" : "002", "ingramPartNumber" : "2GZ200", "addUpdateDeleteLine" : "ADD", "quantity" : 2 } ] } }, "MultipleLines" : { "value" : { "lines" : [ { "customerLineNumber" : "003", "ingramPartNumber" : "2GZ200", "addUpdateDeleteLine" : "ADD", "quantity" : 2 }, { "customerLineNumber" : "004", "ingramPartNumber" : "DF4128", "addUpdateDeleteLine" : "ADD", "quantity" : 2 } ] } }, "Valid SKU and Blank Line Number" : { "value" : { "lines" : [ { "customerLineNumber" : "", "ingramPartNumber" : "1C6094", "addUpdateDeleteLine" : "ADD", "quantity" : 1 } ] } }, "Modify Quantity with integer value" : { "value" : { "lines" : [ { "ingramLineNumber" : "003", "ingramPartNumber" : "1C6094", "addUpdateDeleteLine" : "UPDATE", "quantity" : 2 } ] } }, "Delete single line" : { "value" : { "lines" : [ { "ingramLineNumber" : "004", "ingramPartNumber" : "1C6094", "addUpdateDeleteLine" : "DELETE", "quantity" : 2 } ] } }, "Delete multiple lines" : { "value" : { "lines" : [ { "ingramLineNumber" : "005", "ingramPartNumber" : "1C6094", "addUpdateDeleteLine" : "DELETE", "quantity" : 2 }, { "ingramLineNumber" : "006", "ingramPartNumber" : "TXSLM3", "addUpdateDeleteLine" : "DELETE", "quantity" : 2 } ] } }, "Modify address with valid details" : { "value" : { "shipToInfo" : { "contact" : "Shinchan Corp Contact", "companyName" : "SHINCHAN CORP", "addressLine1" : "2502 N. Fort Valley Road", "addressLine2" : "building 1", "city" : "flagstaff", "state" : "AZ", "postalCode" : "86001", "countryCode" : "US", "phoneNumber" : "800-000-000", "email" : "newcorp@hotmail.com" } } }, "Add header comments(>35 characters) with additionalAttributes" : { "value" : { "notes" : "This is a header comment greater than 35 characters", "additionalAttributes" : [ { "attributeName" : "enableCommentsAsLines", "attributeValue" : "true" } ] } }, "Add header comments(<35 characters) without additionalAttributes" : { "value" : { "notes" : "This is a header comment" } }, "Modify header comments" : { "value" : { "lines" : [ { "ingramLineNumber" : 9, "addUpdateDeleteLine" : "UPDATE", "notes" : "Updated header coments" } ], "additionalAttributes" : [ { "attributeName" : "enableCommentsAsLines", "attributeValue" : "true" } ] } }, "Delete header comments" : { "value" : { "lines" : [ { "ingramLineNumber" : "010", "addUpdateDeleteLine" : "DELETE" } ] } }, "Add line notes" : { "value" : { "lines" : [ { "customerLineNumber" : "010", "ingramPartNumber" : "1C6094", "addUpdateDeleteLine" : "ADD", "quantity" : 1, "notes" : "Line comment" } ], "additionalAttributes" : [ { "attributeName" : "enableCommentsAsLines", "attributeValue" : "true" } ] } }, "Modify line notes" : { "value" : { "lines" : [ { "ingramLineNumber" : "011", "ingramPartNumber" : "1C6094", "addUpdateDeleteLine" : "UPDATE", "quantity" : 1, "notes" : "Updated Line comment" } ], "additionalAttributes" : [ { "attributeName" : "enableCommentsAsLines", "attributeValue" : "true" } ] } }, "Delete line notes" : { "value" : { "lines" : [ { "ingramLineNumber" : "012", "ingramPartNumber" : "1C6094", "addUpdateDeleteLine" : "UPDATE", "quantity" : 1 } ], "additionalAttributes" : [ { "attributeName" : "enableCommentsAsLines", "attributeValue" : "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", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderModifyResponse" }, "examples" : { "OneValidLine-OneInvalidPart" : { "value" : { "ingramOrderNumber" : "30-B3PF2", "orderModifiedDate" : "2021-02-20T15:05:19.515+05:30", "customerOrderNumber" : "MIGRATION_30172001", "orderTotal" : 3801.32, "orderSubTotal" : 3801.32, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "im::hold", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "30-B3PF2-11", "lineNumber" : "005", "customerLineNumber" : "005", "ingramPartNumber" : "2GZ200", "vendorPartNumber" : "SIP-T46S", "quantityOrdered" : 5, "quantityConfirmed" : 5, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" } } ], "rejectedLineItems" : [ { "customerLineNumber" : "006", "ingramPartNumber" : "2GZ2000001", "quantityOrdered" : 6, "rejectCode" : "EN", "rejectReason" : "Line Modification/ Addition for Line Number 006 Failed for reason : ERROR-PART-NOT-FOUNDEN" } ] } }, "Release" : { "value" : null }, "Valid SKU and Blank quantity" : { "value" : { "orderNumber" : "20-RF9N6", "orderModifiedDate" : "2021-03-10T03:31:24.657-08:00", "customerOrderNumber" : "PO79123920", "orderTotal" : 140.02, "orderSubTotal" : 140.02, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "rejectedLineItems" : [ { "customerLineNumber" : "1", "ingramPartNumber" : "DF4128", "rejectCode" : "EQ", "rejectReason" : "ERROR-INVALID-QTY" } ] } }, "Valid SKU with 0 quantity" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T05:14:26.451-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "rejectedLineItems" : [ { "customerLineNumber" : "001", "ingramPartNumber" : "1C6094", "rejectCode" : "EQ", "rejectReason" : "ERROR-INVALID-QTY" } ] } }, "Modify Quantity with invalid ingramLineNumber" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T05:48:36.31-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "rejectedLineItems" : [ { "ingramLineNumber" : "009", "ingramPartNumber" : "1C6094", "quantityOrdered" : 2, "rejectCode" : "EL", "rejectReason" : "ERROR-LINE-NOT-FOUND" } ] } }, "Delete single line" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T05:51:30.809-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "ingramLineNumber" : "004", "customerLineNumber" : "000", "ingramPartNumber" : "1C6094" } ] } }, "Delete single line with invalid ingramLineNumber" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T06:09:26.746-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "rejectedLineItems" : [ { "ingramLineNumber" : "004", "ingramPartNumber" : "1C6094", "quantityOrdered" : 2, "rejectCode" : "EL", "rejectReason" : "ERROR-LINE-NOT-FOUND" } ] } }, "Delete multiple lines" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T06:12:29.656-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "ingramLineNumber" : "005", "customerLineNumber" : "000", "ingramPartNumber" : "1C6094" }, { "ingramLineNumber" : "006", "customerLineNumber" : "000", "ingramPartNumber" : "TXSLM3" } ] } }, "Delete header comments" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-21T00:21:33.419-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "ingramLineNumber" : "010", "customerLineNumber" : "000" } ] } } } } } }, "201" : { "description" : "Created", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderModifyResponse" }, "examples" : { "SingleLine" : { "value" : { "ingramOrderNumber" : "30-B3PF2", "orderModifiedDate" : "2021-02-20T15:05:19.515+05:30", "customerOrderNumber" : "MIGRATION_30172001", "orderTotal" : 3801.32, "orderSubTotal" : 3801.32, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "im::hold", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "30-B3PF2-11", "lineNumber" : "002", "customerLineNumber" : "002", "ingramPartNumber" : "2GZ200", "vendorPartNumber" : "SIP-T46S", "quantityOrdered" : 2, "quantityConfirmed" : 2, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" } } ] } }, "MultipleLines" : { "value" : { "ingramOrderNumber" : "30-B3PF2", "orderModifiedDate" : "2021-02-20T15:05:19.515+05:30", "customerOrderNumber" : "MIGRATION_30172001", "orderTotal" : 3801.32, "orderSubTotal" : 3801.32, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "im::hold", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "30-B3PF2-11", "lineNumber" : "003", "customerLineNumber" : "003", "ingramPartNumber" : "2GZ200", "vendorPartNumber" : "SIP-T46S", "quantityOrdered" : 2, "quantityConfirmed" : 2, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" } }, { "subOrderNumber" : "30-B3PF2-11", "lineNumber" : "004", "customerLineNumber" : "004", "ingramPartNumber" : "DF4128", "vendorPartNumber" : "920-002555", "quantityOrdered" : 2, "quantityConfirmed" : 2, "shipmentDetails" : { "carrierCode" : "PV", "carrierName" : "AMAZON PRIME WC" } } ] } }, "Valid SKU and Blank Line Number" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T05:42:50.003-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "20-RFJWZ-11", "ingramLineNumber" : "3", "customerLineNumber" : "000", "ingramPartNumber" : "1C6094", "quantityOrdered" : 1, "quantityBackOrdered" : 1, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" } } ] } }, "Modify Quantity with integer value" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T05:46:22.36-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "20-RFJWZ-11", "ingramLineNumber" : "4", "customerLineNumber" : "000", "ingramPartNumber" : "1C6094", "quantityOrdered" : 2, "quantityBackOrdered" : 2, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" } } ] } }, "Modify address with valid details" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T06:47:39.455-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "shipToInfo" : { "contact" : "SHINCHAN CORP CONTACT", "companyName" : "SHINCHAN CORP", "addressLine1" : "2502 N FORT VALLEY RD", "addressLine2" : "BUILDING 1", "city" : "FLAGSTAFF", "state" : "AZ", "postalCode" : "860010000", "countryCode" : "US", "phoneNumber" : "800-000-000", "email" : "newcorphotmail.com" } } }, "Add header comments(>35 characters) with additionalAttributes" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T06:56:53.403-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "ingramLineNumber" : "007", "customerLineNumber" : "1", "notes" : "THIS IS A HEADER COMMENT GREATER TH" }, { "ingramLineNumber" : 8, "customerLineNumber" : "2", "notes" : "AN 35 CHARACTERS" } ] } }, "Add header comments(<35 characters) without additionalAttributes" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T07:02:03.521-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "notes" : "This is a header comment", "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "ingramLineNumber" : 9, "customerLineNumber" : "1", "notes" : "THIS IS A HEADER COMMENT" } ] } }, "Modify header comments" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T07:04:48.453-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "20-RFJWZ-11", "ingramLineNumber" : "10", "customerLineNumber" : "000", "notes" : "UPDATED HEADER COMENTS" } ] } }, "Add line notes" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T07:08:46.101-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "20-RFJWZ-11", "ingramLineNumber" : "11", "customerLineNumber" : "010", "ingramPartNumber" : "1C6094", "quantityOrdered" : 1, "quantityBackOrdered" : 1, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" }, "notes" : "20IN WS LED 1080P VA2055SM VGA MNTR || DVI SUPERCLEAR MVA PANEL || LINE COMMENT" } ] } }, "Modify line notes" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T07:11:33.17-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "20-RFJWZ-11", "ingramLineNumber" : "12", "customerLineNumber" : "000", "ingramPartNumber" : "1C6094", "quantityOrdered" : 1, "quantityBackOrdered" : 1, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" }, "notes" : "20IN WS LED 1080P VA2055SM VGA MNTR || DVI SUPERCLEAR MVA PANEL || UPDATED LINE COMMENT" } ] } }, "Delete line notes" : { "value" : { "ingramOrderNumber" : "20-RFJWZ", "orderModifiedDate" : "2021-05-20T07:13:56.466-07:00", "customerOrderNumber" : "STYPETEST3", "orderTotal" : 14.29, "orderSubTotal" : 14.29, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "ON HOLD", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "20-RFJWZ-11", "ingramLineNumber" : "13", "customerLineNumber" : "000", "ingramPartNumber" : "1C6094", "quantityOrdered" : 1, "quantityBackOrdered" : 1, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" } } ] } } } } } }, "207" : { "description" : "Multi-Status", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderModifyResponse" }, "examples" : { "ValidLine-InvalidAddress" : { "value" : { "ingramOrderNumber" : "30-B3PF2", "orderModifiedDate" : "2021-02-20T15:05:19.515+05:30", "changeDescription" : "Invalid details in shipping adress.Please update line details with valid data", "customerOrderNumber" : "MIGRATION_30172001", "orderTotal" : 3801.32, "orderSubTotal" : 3801.32, "freightCharges" : 0, "totalTax" : 0, "orderStatus" : "im::hold", "billToAddressId" : "000", "lines" : [ { "subOrderNumber" : "30-B3PF2-11", "lineNumber" : "002", "customerLineNumber" : "002", "ingramPartNumber" : "2GZ200", "vendorPartNumber" : "SIP-T46S", "quantityOrdered" : 1, "quantityConfirmed" : 1, "shipmentDetails" : { "carrierCode" : "OT", "carrierName" : "OTHER" } } ] } } } } } }, "400" : { "description" : "Bad Request", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Single Error" : { "value" : { "errors" : [ { "id" : "123-bw0a10t3-2021-02-19T11:10:03.497-08:00", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "OrderNumber", "value" : "20-123", "message" : "OrderNumber must be in the format xx-xxxxx or xx-xxxxx-xx" } ] } ] } }, "Multiple Errors" : { "value" : { "errors" : [ { "id" : "-bw0a10t1-2021-02-19T11:04:37.312-08:00", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "20-22222222", "message" : "IM-CustomerNumber must be in the format XX-XXXXXX" }, { "field" : "IM-CorrelationID", "value" : "", "message" : "IM-CorrelationID cannot be blank" } ] } ] } }, "Modify address with invalid details" : { "value" : { "errors" : [ { "id" : "AxYqwpeo=sa-Fgwh", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "shipToAddress", "message" : "Invalid details in shipping adress.Please update shipping address details with valid data" } ] } ] } }, "Order already released" : { "value" : { "errors" : [ { "id" : "AxYqwpeo=sa-Fgwh", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "message" : "Order can not be modified/released. Order is already released or Order is not placed on Customer Hold" } ] } ] } } } } } }, "401" : { "description" : "Unauthorized" }, "404" : { "description" : "Not Found" }, "500" : { "description" : "Internal Server Error", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "C123-bw0a10u3-2021-02-19T11:12:26.436-08:00", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred, please contact support team for more details. " } ] } } } } } } } } }, "/resellers/v7/orders/{ordernumber}":{ "get":{ "summary" : "Get Order Details V7", "tags": ["Orders v7"], "description": "The Order Details API allows resellers to easily retrieve consolidated order details for a specific Ingram Micro sales order number used as a path parameter.\n\nThe response covers order header details, billing and shipping information, invoice references, and line items with shipment and tracking data (including IMEI numbers). The response also includes subscription order data (`cmpLines`), covering both Technology Solutions (TS) and Cloud/Subscription orders in one place.\n\n---\n\n## What’s New in V7\n\nThe following capabilities are new or improved in V7 compared to the previous version:\n\n| Capability / Field | Description |\n|-------------------|-------------|\n| confirmationNumber (header) | New header field returning the async confirmationNumber from Order Create V7. |\n| quoteNumber (header) | New field surfacing the quote number for Quote-to-Order traceability throughout the order lifecycle. |\n| dealID (header) | New field returning the deal ID for special bid and deal-based orders. |\n| orderStatusDescription (header) | Description of the order status, providing additional context. |\n| smartAccountNumber / resellerTcv | New header fields for total contract value and Cisco smart account association. |\n| IMEI numbers in trackingDetails | imeiNumbers[] returned alongside serialNumbers[] within carrierDetails, supporting mobile device and IoT inventory and warranty tracking. |\n| trackingUrl in carrierDetails | Direct tracking URL from the carrier/vendor (e.g. https://www.seur.com/ ...). |\n| alternateCarrierCode | New field within carrierDetails containing the vendor carrier code when Direct Ship; and actual carrier code from the carrier system for Stocked (e.g. UPSN). |\n| invoices[] at header level | Invoice references moved from inside shipmentDetails to a dedicated top-level array. Use invoices[].shipmentId to cross-reference back to a specific shipment. |\n| quantityShipped | New integer field returned at line level, positioned after quantityBackOrdered. Reflects the actual quantity shipped. quantityConfirmed now represents allocated quantity prior to shipment only and should no longer be used as a proxy for shipped quantity. |\n| cmpLines[] (cloud order lines) | New top-level array for subscription orders: plan, billing frequency, renewal term, reseller and end-customer pricing via childLines. |\n| customerOrderTotals (cloud) | New object on cloud orders: subTotal, total, totalFees, totalTaxes, customerTcv. |\n| vendorRequestedInformation[] | New array returning vendor-requested attributes collected at order time. |\n| estimatedShipDate — array | Changed from string to array of objects with fromDate, toDate, quantity, description. Returns null for lines that have already shipped — treat null as expected, not an error. |\n|Important changes from V6.1 |V7 introduces structural changes that require integration updates and is not additive-compatible with V6.1. The shipmentDetails array has changed in granularity and now contains one object per physical carton or tracking number (carton level) instead of one object per order line (line level). The trackingDetails field has changed from an array ([]) to a single object ({}), and parsers expecting an array will break. The quantityInBox field has changed from a string value (e.g., \"2\") to an integer (e.g., 2). The shippedDate field has been renamed to shippedDateTime.|\n|Removed fields from V6.1 | The following fields present in V6.1 are no longer returned in V7: shipmentDetails[]: invoiceNumber, invoiceDate — moved to top-level invoices[].| ", "operationId" : "get-orderdetails-v7", "security" : [ { "application" : [ "read" ] } ], "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "description": "The Ingram Micro sales order number. Example: 29-Y6T03", "schema": { "type": "string", "maxLength": 12 } }, { "name": "OrderDate", "in": "query", "required": false, "description": "Date the order was created in UTC format (yyyy-MM-dd). Example: 2026-02-10", "schema": { "type": "string", "format": "date", "example": "2026-02-10" } },{ "name": "IM-CustomerNumber", "in": "header", "required": true, "description": "Your unique Ingram Micro customer number. Example: 20-222222", "schema": { "type": "string", "maxLength": 10, "example": "20-222222" } }, { "name": "IM-CountryCode", "in": "header", "required": true, "description": "Two-character ISO country code. Example: US", "schema": { "type": "string", "maxLength": 2, "example": "US" } }, { "name": "IM-CorrelationID", "in": "header", "required": true, "description": "Unique transaction number to identify each transaction across all systems.", "schema": { "type": "string", "maxLength": 32, "example": "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name": "IM-SenderID", "in": "header", "required": false, "description": "Unique value used to identify the sender of the transaction. Example: MyCompany", "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" } } ], "responses": { "200": { "description": "Order details retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsV7Response" } } } } } } }, "/resellers/v7/orders/search":{ "get":{ "summary" : "Search your Orders V7", "tags": ["Orders v7"], "description": "The Orders Search API allows customers to search and retrieve their Ingram Micro orders using a wide range of query parameters. Customers can perform searches using a single query parameter or combine multiple parameters to refine results. The API also supports pagination to efficiently navigate large result sets.\n\nVersion 7 (V7) represents a significant evolution over previous versions and brings enhanced parity with the Xvantage platform. It introduces unified support for both traditional and Cloud orders through a single endpoint, including subscription change, renewal, and cancellation orders.\n\nThese enhancements provide a more comprehensive, flexible, and consistent order search experience across all order types.\n\n **What’s New in V7**\n\nThe following capabilities are new or improved in Version 7.\n\n## V7 Order Enhancements & Capabilities\n\n| Capability | Description |\n|------------|-------------|\n| **Cloud order visibility** | Cloud orders (subscription change, billing, renewal, and cancellation orders) now appear in search results with `orderType: Cloud Solutions`. These were previously not available. |\n| **orderType / subOrderType fields** | New fields on each order (Technology Solutions, Cloud Solutions) and sub-order types (Stocked, DirectShip or Cloud specific statuses). |\n| **confirmationNumber** | Orders placed via async Order Create V7 can be searched using `confirmationNumber`. This field is also returned on every order in the response. |\n| **orderPlacedBy** | Shows who or which system placed the order. |\n| **Expanded orderStatus values** | V7 adds `SALES HOLD`, `CUSTOMER HOLD`, and `ORDER FULFILLMENT`, matching Xvantage platform states exactly. |\n| **subOrderStatusDescription** | Cloud sub-orders include a human-readable status description (for example, `PROVISIONING ON HOLD`). |\n| **ETA (Estimated Ship Date)** | Improved ETA coverage through stronger vendor connectivity and internal process improvements. | ", "operationId" : "get-orderd-search-v7", "security" : [ { "application" : [ "read" ] } ], "parameters": [ { "name": "customerOrderNumber", "in": "query", "description": "Search by your PO or order number.", "required": false, "schema": { "type": "string", "maxLength": 35 } }, { "name": "ingramOrderNumber", "in": "query", "description": "Search by Ingram Micro order number.", "required": false, "schema": { "type": "string", "maxLength": 11 } }, { "name": "orderStatus", "in": "query", "description": "Single status filter.", "required": false, "schema": { "type": "string", "enum": [ "OPEN", "BACKORDERED", "SALES_HOLD", "CREDIT_REVIEW", "PARTIALLY_SHIPPED", "SHIPPED", "PARTIALLY_DELIVERED", "DELIVERED", "CANCELLED", "COMPLETED", "IN_PROGRESS", "PARTIALLY_PROCESSED", "VOIDED", "ORDER_REVIEW", "CREDIT_CHECK", "PROCESSING", "READY_TO_SHIP", "READY_FOR_PICKUP", "PROVISIONING_FAILED", "ACTION_REQUIRED", "SCHEDULED", "PENDING_APPROVAL", "ACTIVATION_DATE_VALIDATION_FAILED", "PENDING_TERMS_AND_ACCEPTANCE", "ACTION_REQUIRED_PROVISIONING_IN_PROGRESS", "ORDER_FULFILLMENT" ] } }, { "name": "orderStatus-in", "in": "query", "description": "Multiple statuses in one call (e.g. SHIPPED, DELIVERED).", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "endCustomerName", "in": "query", "description": "Search by end customer company name.", "required": false, "schema": { "type": "string", "maxLength": 35 } }, { "name": "vendorName", "in": "query", "description": "Search by vendor name (e.g. Cisco, Microsoft).", "required": false, "schema": { "type": "string", "maxLength": 35 } }, { "name": "ingramOrderDate_bt", "in": "query", "description": "Order date range. Two entries: start and end (yyyy-MM-dd). Example: 2025-12-01,2026-02-12.", "required": false, "schema": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "string", "format": "date" } }, "style": "form", "explode": false }, { "name": "ingramOrderDate", "in": "query", "description": "Search by exact order date (yyyy-MM-dd).", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "confirmationNumber", "in": "query", "description": "V7 only. Search by the async confirmationNumber from Order Create V7.", "required": false, "schema": { "type": "string" } }, { "name": "endCustomerOrderNumber", "in": "query", "description": "End customer purchase order number.", "required": false, "schema": { "type": "string", "maxLength": 35 } }, { "name": "invoiceDate_bt", "in": "query", "description": "Invoice date range. Two entries only: start and end date (yyyy-MM-dd).", "required": false, "schema": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "string", "format": "date" } }, "style": "form", "explode": false }, { "name": "deliveryDate_bt", "in": "query", "description": "Delivery date range. Two entries only: start and end date (yyyy-MM-dd).", "required": false, "schema": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "string", "format": "date" } }, "style": "form", "explode": false }, { "name": "shipDate_bt", "in": "query", "description": "Shipment date range. Two entries only: start and end date (yyyy-MM-dd).", "required": false, "schema": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "string", "format": "date" } }, "style": "form", "explode": false }, { "name": "ingramPartNumber", "in": "query", "description": "Ingram Micro unique part number for the product.", "required": false, "schema": { "type": "string", "maxLength": 35 } }, { "name": "vendorPartNumber", "in": "query", "description": "Vendor’s part number for the product.", "required": false, "schema": { "type": "string", "maxLength": 35, "example": "N6PATC1MBK" } }, { "name": "serialNumber", "in": "query", "description": "A serial number of the product.", "required": false, "schema": { "type": "string", "maxLength": 35 } }, { "name": "trackingNumber", "in": "query", "description": "The tracking number of the order.", "required": false, "schema": { "type": "string", "maxLength": 35, "example": "JJD00006085022510180001" } }, { "name": "specialBidNumber", "in": "query", "description": "Vendor-provided bid number for special pricing. Line-level bids take precedence over header-level bids.", "required": false, "schema": { "type": "string", "maxLength": 35 } }, { "name": "orderType", "in": "query", "description": "Filter by order type.", "required": false, "schema": { "type": "string", "enum": [ "Technology Solutions", "Cloud Solutions" ] } }, { "name": "subOrderType", "in": "query", "description": "Filter by sub-order type.", "required": false, "schema": { "type": "string", "enum": [ "Stock", "Directship", "Sales", "Cancellation", "Renewal", "Change", "Transfer Account", "Transfer Subscription", "Billing" ] } }, { "name": "pageSize", "in": "query", "description": "Records per page. Default: 25, maximum: 100.", "required": false, "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "pageNumber", "in": "query", "description": "Page number reference. Default: 1.", "required": false, "schema": { "type": "integer", "default": 1 } } ,{ "name": "IM-CustomerNumber", "in": "header", "required": true, "description": "Your unique Ingram Micro customer number. Example: 20-222222", "schema": { "type": "string", "maxLength": 10, "example": "20-222222" } }, { "name": "IM-CountryCode", "in": "header", "required": true, "description": "Two-character ISO country code. Example: US", "schema": { "type": "string", "maxLength": 2, "example": "US" } }, { "name": "IM-CorrelationID", "in": "header", "required": true, "description": "Unique transaction number to identify each transaction across all systems.", "schema": { "type": "string", "maxLength": 32, "example": "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name": "IM-SenderID", "in": "header", "required": false, "description": "Unique value used to identify the sender of the transaction. Example: MyCompany", "schema": { "type": "string", "maxLength": 32, "example": "MyCompany" } } ], "responses": { "200": { "description": "Order search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSearchV7Response" }, "examples": { "StockedOrderWithETA": { "summary": "Stocked order — with ETA", "value": { "ingramOrderNumber": "20-T777Y", "ingramOrderDate": "2025-05-06T01:11:43+00:00", "customerOrderNumber": "MyPONumber", "orderType": "Stocked", "vendorSalesOrderNumber": "", "vendorName": "STARTECH - CABLES", "endUserCompanyName": "ABC TECHNOLOGIES", "confirmationNumber": "US-I-T-25050611419008739027", "ingramPurchaseOrderNumber": "", "orderPlacedBy": "XETO", "orderTotal": 29.88, "orderStatus": "DELIVERED", "eta": "", "subOrders": [ { "subOrderNumber": "20-T777Y-11", "subOrderType": "Stocked", "subOrderStatus": "DELIVERED", "subOrderTotal": 29.88 } ], "links": { "topic": "orders", "href": "/resellers/v7/orders/20-T777Y?orderDate=2025-05-06", "type": "GET" } } }, "CloudSubscriptionOrder": { "summary": "Cloud / Subscription order — with subOrderStatusDescription", "value": { "ingramOrderNumber": "BO000049", "ingramOrderDate": "2026-03-09T17:30:07+00:00", "customerOrderNumber": "PO25061711261387", "orderType": "Cloud", "vendorSalesOrderNumber": "", "vendorName": "", "endUserCompanyName": "ABC TECHNOLOGIES", "confirmationNumber": "", "ingramPurchaseOrderNumber": "", "orderPlacedBy": "System", "orderTotal": 29.74, "orderStatus": "COMPLETED", "eta": "", "subOrders": [ { "subOrderNumber": "BO000049", "subOrderType": "Billing order", "subOrderStatus": "COMPLETED", "subOrderStatusDescription": "COMPLETED", "subOrderTotal": 29.74 } ], "links": { "topic": "orders", "href": "/resellers/v7/orders/BO000049?orderDate=2026-03-09", "type": "GET" } } }, "DirectShipCustomerHold": { "summary": "DirectShip order — CUSTOMER HOLD", "value": { "ingramOrderNumber": "20-Z1449", "orderType": "DirectShip", "vendorName": "CISCO SAAS ANNUITY", "confirmationNumber": "US-C-T-26031837551205682598", "orderPlacedBy": "Jane Doe", "orderTotal": 7.30, "orderStatus": "CUSTOMER HOLD", "eta": "", "subOrders": [ { "subOrderNumber": "20-Z1449", "subOrderType": "DirectShip", "subOrderStatus": "ON HOLD", "subOrderTotal": 7.30 } ], "links": { "href": "/resellers/v7/orders/20-Z1449?orderDate=2026-03-18", "type": "GET" } } } } } } } } } }, "/resellers/v6.1/orders/{ordernumber}" : { "get" : { "summary" : "Get Order Details v6.1", "operationId" : "get-orderdetails-v6.1", "description" : "The Orders details API endpoint allows a customer to retrieve their Ingram Micro orders details by using the Ingram Micro sales order number as a path parameter. The sales order number, IM-CustomerNumber, IM-CountryCode, and IM-CorrelationID are required parameters.

*Service contracts, subscriptions, and license information are unavailable at the moment, this information will be available in the future.

Recent bug fixes:\n\n - Fixed duplication of serial numbers in the API response.\n\n - Fixed API time-out issues\n\n - Fixed missing tracking information.\n\n - Implemented enhanced order status.\n\n", "tags" : [ "Orders" ], "parameters" : [ { "name" : "ordernumber", "in" : "path", "description" : "The Ingram Micro sales order number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 12, "example" : "20-RD3QV" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "required" : true, "description" : "Two-character ISO country code.", "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "required" : true, "description" : "Unique transaction number to identify each transaction across all the systems.", "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany.", "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "ingramOrderDate", "in" : "query", "description" : "The date and time in UTC format that the order was created.", "required" : false, "schema" : { "type" : "string", "format" : "date", "example" : "2020-05-13" } }], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderDetailB2B" }, "examples" : { "Success" : { "value" : { "ingramOrderNumber" : "20-RD3QV", "ingramOrderDate" : "2020-05-13T00:38:52-07:00", "orderType" : "D", "customerOrderNumber" : "16", "endCustomerOrderNumber" : "16", "webOrderId" : "93455594", "vendorSalesOrderNumber" : "114945339", "ingramPurchaseOrderNumber" : "80CLY55", "orderStatus" : "Processing", "orderTotal" : 25371.27, "orderSubTotal" : 25371.27, "freightCharges" : 0, "currencyCode" : "USD", "totalWeight" : 1, "totalTax" : 0, "paymentTerms" : "NET 20 DAYS", "notes" : "********* DIRECT SHIP INFO ******** || JON.HAWKINS@PNMRESOURCES.COM || ECTN PNM || EU-CNT-PH #505-987-3456 - || EU-PO-ID# 16", "billToInfo" : { "contact" : "CLAY MORGANX67468", "companyName" : "INGRAM MICRO CAPS TEST ACCOUNT", "addressLine1" : "1759 WEHRLE DR", "addressLine2" : "", "city" : "WILLIAMSVILLE", "state" : "NY", "postalCode" : "142210000", "countryCode" : "US", "phoneNumber" : "8286674626", "email" : "clay.morgan@ingram.com" }, "shipToInfo" : { "contact" : "RALPH BIZZELL", "companyName" : "ASBURY METHODIST CHURCH", "addressLine1" : "INGRAM MICRO TEST ACCOUNT", "addressLine2" : "ATTN TOD DEBIE", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US", "phoneNumber" : "8286674626", "email" : "clay.morgan@ingram.com" }, "endUserInfo" : { "contact" : "RALPH BIZZELL", "companyName" : "ASBURY METHODIST CHURCH", "addressLine1" : "INGRAM MICRO TEST ACCOUNT", "addressLine2" : "ATTN TOD DEBIE", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US", "phoneNumber" : "8286674626", "email" : "clay.morgan@ingram.com" }, "lines" : [ { "subOrderNumber" : "20-RD3QV-11", "ingramOrderLineNumber" : "002", "vendorSalesOrderLineNumber" : "114945339", "customerLineNumber" : "001", "lineStatus" : "In Progress", "ingramPartNumber" : "4AW708", "vendorPartNumber" : "BE7H-M5-K9", "vendorName" : "CISCO - HW UNIFIED COMM", "partDescription" : "BUSINESS ED 7000H M5 APPL", "unitWeight" : 0, "weightUom" : "EA", "unitPrice" : 20887.57, "upcCode" : "", "extendedPrice" : 20887.57, "taxAmount" : 0, "currencyCode" : "USD", "quantityOrdered" : 1, "quantityConfirmed" : 1, "quantityBackOrdered" : 0, "specialBidNumber" : "3223A", "requestedDeliverydate" : "", "promisedDeliveryDate" : "2020-05-13", "lineNotes" : "EU#- 001837114 ABC Technologies || MC# C", "shipmentDetails" : [ { "quantity" : 1, "deliveryNumber" : "23423423", "estimatedShipDate" : "2022-10-07", "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA", "invoiceNumber" : "20RD3QV11", "invoiceDate" : "2022-10-07", "carrierDetails" : [ { "carrierCode" : "VL", "carrierName" : "VIRTUAL", "quantity" : 0, "shippedDate" : "2022-10-07", "estimatedDeliveryDate" : "2022-10-07", "deliveredDate" : "2022-10-07", "carrierPickupDate" : "2022-10-07", "trackingDetails" : [ { "trackingNumber" : "390064340282", "trackingUrl" : "string", "packageWeight" : "1.2", "cartonNumber" : "1", "quantityInBox" : "1", "serialNumbers" : [ { "serialNumber" : "Q2EV-5SJ3-E6LN" } ] } ] } ] } ], "serviceContractInfo" : { "contractInfo" : { "contractDescription" : "Cisco IP Phone 7841 with Multiplatform Phone firmwareSNTC-8X", "contractNumber" : "205004823", "contractStatus" : "MANUALLY_CONVERTED", "contractStartDate" : "2022-10-09", "contractEndDate" : "2023-10-08", "contractDuration" : null }, "subscriptions" : { "subscriptionId" : "Cisco IP Phone 7841 with Multiplatform", "subscriptionTerm" : "1", "renewalTerm" : "1", "billingModel" : "YEAR", "subcriptionStartDate" : "2022-10-09", "subcriptionEndDate" : "2023-10-09" }, "licenseInfo" : { "licenseNumber" : [ "EX2SXV2NBNR" ], "licenseStartDate" : "2022-10-07", "licenseEndDate" : "2023-10-07", "description" : "Cisco AnyConnect VPN Only, 25 Simultaneous (eDelivery)", "quantity" : "1" } }, "additionalAttributes" : [ { "attributeName" : "additional description", "attributeValue" : "EXPORT RESTR SW" } ], "links" : [ { "topic" : "invoices", "href" : "/resellers/v6.1/invoices/7870011?customerNumber=70-386612&isoCountryCode=US", "type" : "GET" } ], "estimatedDates" : [ { "ship" : { "shipDateType" : "Single", "shipDateRange" : { "startDate" : null, "endDate" : null }, "shipSource" : "INGRAM", "shipDescription" : "Warehouse is processing your Shipment", "shipDate" : "2023-06-05" }, "delivery" : null }, { "ship" : null, "delivery" : { "deliveryDateType" : "Single", "deliveryDateRange" : { "startDate" : null, "endDate" : null }, "deliverySource" : null, "deliveryDescription" : null, "deliveryDate" : "2023-06-08" } } ], "scheduleLines" : null, "multipleShipments" : [ { "lineNumber" : null, "requestedQuantity" : 0, "confirmedQuantity" : 1, "dateType" : "Single", "dateRange" : { "startDate" : null, "endDate" : null }, "source" : "INGRAM", "description" : "Warehouse is processing your Shipment", "date" : "2023-06-05", "deliveryDate" : "2023-06-08" } ] } ], "miscellaneousCharges" : [ { "subOrderNumber" : "20-RD3QV-11", "chargeLineReference" : "885", "chargeDescription" : "RECYCLING FEE BC", "chargeAmount" : "4.7" }, { "subOrderNumber" : "20-RD3QV-11", "chargeLineReference" : "GST", "chargeDescription" : "STATETAX", "chargeAmount" : "100.4" } ], "additionalAttributes" : [ { "attributeName" : "additional description", "attributeValue" : "EXPORT RESTR SW" } ] } } } } } }, "500" : { "description" : "Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponseDTO" } } } } }, "security" : [ { "application" : [ "read" ] } ] } }, "/resellers/v6/orders/{ordernumber}" : { "get" : { "summary" : "Get Order Details v6", "tags" : [ "Orders v6" ], "description" : "Use your Ingram Micro sales order number to search for existing orders or retrieve existing order details.\n\nThe sales order number, IM-CustomerNumber, IM-CountryCode, IM-SenderID and IM-CorrelationID are required parameters.\n\nIn a case when the IM sales order number is repeated, you can refine the result by providing for additional filtering.\n\nUse the \"simulateStatus\" query parameter to test the GET order response for various order statuses. This parameter is only available in the sandbox to help with development and testing of the GET order endpoint.", "operationId" : "get-orderdetails-v6", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "ordernumber", "in" : "path", "description" : "The Ingram Micro sales order number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 12, "example" : "20-RD3QV" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "ingramOrderDate", "in" : "query", "description" : "The date and time in UTC format that the order was created.", "required" : false, "schema" : { "type" : "string", "format" : "date", "example" : "2020-05-13" } }, { "name" : "vendorNumber", "in" : "query", "description" : "Vendor Number.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "simulateStatus", "in" : "query", "description" : "Order response for various order statuses. Not for use in production.", "required" : false, "schema" : { "type" : "string", "enum" : [ "IM::SHIPPED", "IM::PARTIALLY_SHIPPED", "IM::HOLD", "IM::INVOICED" ] } }, { "name" : "isIml", "in" : "query", "description" : "True/False only for IML customers.", "required" : false, "schema" : { "type" : "boolean" } }, { "name" : "regionCode", "in" : "query", "description" : "Region code for sandbox testing - Not for use in production.", "required" : false, "schema" : { "type" : "string" } } ], "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", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderDetailResponse" }, "examples" : { "Success" : { "value" : { "ingramOrderNumber" : "20-RD3QV", "ingramOrderDate" : "2020-05-13T00:38:52-07:00", "orderType" : "D", "customerOrderNumber" : "16", "endCustomerOrderNumber" : "16", "orderStatus" : "Processing", "orderTotal" : 25371.27, "orderSubTotal" : 25371.27, "currencyCode" : "USD", "totalWeight" : 1, "totalTax" : 0, "paymentTerms" : "NET 20 DAYS", "notes" : "********* DIRECT SHIP INFO ******** || JON.HAWKINS@PNMRESOURCES.COM || ECTN PNM || EU-CNT-PH #505-987-3456 - || EU-PO-ID# 16", "billToInfo" : { "contact" : "CLAY MORGANX67468", "companyName" : "INGRAM MICRO CAPS TEST ACCOUNT", "addressLine1" : "1759 WEHRLE DR", "city" : "WILLIAMSVILLE", "state" : "NY", "postalCode" : "142210000", "countryCode" : "US" }, "shipToInfo" : { "addressLine1" : "INGRAM MICRO TEST ACCOUNT", "addressLine2" : "ATTN TOD DEBIE", "city" : "SANTA ANA", "state" : "CA", "postalCode" : "927054931", "countryCode" : "US" }, "lines" : [ { "subOrderNumber" : "20-RD3QV-11", "ingramOrderLineNumber" : "002", "customerLineNumber" : "001", "lineStatus" : "In Progress", "ingramPartNumber" : "4AW708", "vendorPartNumber" : "BE7H-M5-K9", "vendorName" : "CISCO - HW UNIFIED COMM", "partDescription" : "BUSINESS ED 7000H M5 APPL", "unitWeight" : 0, "weightUom" : "EA", "unitPrice" : 20887.57, "extendedPrice" : 20887.57, "taxAmount" : 0, "currencyCode" : "USD", "quantityOrdered" : 1, "quantityConfirmed" : 1, "quantityBackOrdered" : 0, "promisedDeliveryDate" : "2020-05-13", "lineNotes" : "EU#- 001837114 ABC Technologies || MC# C", "shipmentDetails" : [ { "quantity" : 1, "shipFromWarehouseId" : "10", "shipFromLocation" : "Mira Loma, CA", "carrierDetails" : { "carrierCode" : "VL", "carrierName" : "VIRTUAL" } } ], "additionalAttributes" : [ { "attributeName" : "additional description", "attributeValue" : "EXPORT RESTR SW" } ] } ] } } } } } }, "204" : { "description" : "No Content", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Data not found" : { "value" : null } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Single Error" : { "value" : { "errors" : [ { "id" : "123-bw0a10t3-2021-02-19T11:10:03.497-08:00", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "OrderNumber", "value" : "20-123", "message" : "OrderNumber must be in the format xx-xxxxx or xx-xxxxx-xx" } ] } ] } }, "Multiple Errors" : { "value" : { "errors" : [ { "id" : "-bw0a10t1-2021-02-19T11:04:37.312-08:00", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "20-22222222", "message" : "IM-CustomerNumber must be in the format XX-XXXXXX" }, { "field" : "IM-CorrelationID", "value" : "", "message" : "IM-CorrelationID cannot be blank" }, { "field" : "IM-SenderID", "value" : "", "message" : "IM-SenderID cannot be blank" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "C123-bw0a10u3-2021-02-19T11:12:26.436-08:00", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred, please contact support team for more details" } ] } } } } } } } } }, "/resellers/v6/orders/search" : { "get" : { "summary" : "Search your Orders", "tags" : [ "Orders" ], "description" : "The Orders Search API endpoint allows a customer to search their Ingram Micro orders by using any of the available query string parameters, customer can search their order by using single query string parameters or combining them together. This endpoint supports the pagination of results.", "operationId" : "get-resellers-v6-ordersearch", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "ingramOrderNumber", "in" : "query", "description" : "The Ingram Micro order number.", "required" : false, "schema" : { "type" : "string", "maxLength" : 11 } }, { "name" : "orderStatus", "in" : "query", "description" : "Ingram Micro order status.", "required" : false, "schema" : { "type" : "string", "enum" : [ "SHIPPED", "PROCESSING", "ON HOLD", "BACKORDERED", "CANCELLED" ] } }, { "name" : "orderStatus-in", "in" : "query", "description" : "Ingram Micro order status(can use it for multiple entries).", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "uniqueItems" : false } } }, { "name" : "ingramOrderDate", "in" : "query", "description" : "Search by Order date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "ingramOrderDate-bt", "in" : "query", "description" : "Search with the start and end date(only 2 entries allowed).", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "uniqueItems" : false } } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222", "maxLength" : 10 } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "example" : "US", "maxLength" : 2, "minLength" : 2 } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "customerOrderNumber", "in" : "query", "description" : "Search using your PO/Order number.", "required" : false, "schema" : { "type" : "string", "maxLength" : 35 } }, { "name" : "pageSize", "in" : "query", "description" : "The number of records required in the call - max records 100 per page.", "required" : false, "schema" : { "type" : "integer", "default" : "25", "format" : "int32" } }, { "name" : "pageNumber", "in" : "query", "description" : "The page number reference.", "required" : false, "schema" : { "type" : "integer", "default" : "1", "format" : "int32" } }, { "name" : "endCustomerOrderNumber", "in" : "query", "description" : "End customer/user purchase order number.", "required" : false, "schema" : { "type" : "string", "maxLength" : 35 } }, { "name" : "invoiceDate_bt", "in" : "query", "description" : "Invoice date of order, search with the start and end date(only 2 entries allowed).*Currently, this feature is not available in Australia.", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "uniqueItems" : false } } }, { "name" : "shipDate_bt", "in" : "query", "description" : "Shipment date of order, search with the start and end date(only 2 entries allowed).", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "uniqueItems" : false } } }, { "name" : "deliveryDate_bt", "in" : "query", "description" : "The delivery date of the order, search with the start and end date(only 2 entries allowed).*Currently, this feature is not available in Australia", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "uniqueItems" : false } } }, { "name" : "ingramPartNumber", "in" : "query", "description" : "Ingram Micro unique part number for the product.", "required" : false, "schema" : { "type" : "string", "maxLength" : 35 } }, { "name" : "vendorPartNumber", "in" : "query", "description" : "Vendor’s part number for the product.", "required" : false, "schema" : { "type" : "string", "maxLength" : 35 } }, { "name" : "serialNumber", "in" : "query", "description" : "A serial number of the product.", "required" : false, "schema" : { "type" : "string", "maxLength" : 35 } }, { "name" : "trackingNumber", "in" : "query", "description" : "The tracking number of the order.*Currently, this feature is not available in Australia", "required" : false, "schema" : { "type" : "string", "maxLength" : 35 } }, { "name" : "vendorName", "in" : "query", "description" : "Name of the vendor.", "required" : false, "schema" : { "type" : "string", "maxLength" : 35 } }, { "name" : "specialBidNumber", "in" : "query", "description" : "The bid number provided to the reseller by the vendor for special pricing and discounts. Line-level bid numbers take precedence over header-level bid numbers.*Currently, this feature is not available in Australia", "required" : false, "schema" : { "type" : "string", "maxLength" : 35 } } ], "responses" : { "200" : { "description" : "OrderSearch_Response to be returned", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderSearch_Response" }, "examples" : { "Success - 200" : { "value" : { "recordsFound" : "123", "pageSize" : "25", "pageNumber" : "1", "orders" : [ { "ingramOrderNumber" : "20-RD128", "ingramOrderDate" : "2020-04-03T08:54:39+05:30", "customerOrderNumber" : "MyPONumber", "vendorSalesOrderNumber" : "8987380", "vendorName" : "Microsoft", "endUserCompanyName" : "ABC TECHNOLOGIES", "orderTotal" : "120.00", "orderStatus" : "OPEN", "subOrders" : [ { "subOrderNumber" : "20-RD128-11", "subOrderTotal" : "100.00", "subOrderStatus" : "SHIPPED", "links" : { "topic" : "orders", "href" : "/resellers/v6.1/orders/20-RD128-11", "type" : "GET" } }, { "links" : { "topic" : "orders", "href" : "/resellers/v6.1/orders/20-RD128", "type" : "GET" } } ] } ], "nextPage" : "/resellers/v6/orders/[original_parameters]&pageNumber=2", "previousPage" : "/resellers/v6/orders/[original_parameters]&pageNumber=1" } } } } } }, "204" : { "description" : "No Content", "headers" : { "IM-CorrelationID" : { "description" : "Unique transaction number to identify each transaction across all the systems.", "schema" : { "type" : "string" } }, "IM-SenderID" : { "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "schema" : { "type" : "string", "example" : "MyCompany" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "id" : "d27059e19119", "1ype" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "customerOrderNumber", "message" : "Required field is missing" }, { "field" : "ingramOrderDate/ingramOrderDate-bt", "message" : "input date format error expected format is - yyyy-MM-dd", "value" : "2020-10-21" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "74681b27-b1ea-454d-9847-d27059e19119", "type" : "/errors/server-error", "message" : "ConnectivityIssue/ERP issue Contact Ingram Micro API Support " } ] } } } } } } } } }, "/resellers/v6/orders/{OrderNumber}" : { "delete" : { "summary" : "Cancel your Order", "tags" : [ "Orders" ], "description" : "This call must be submitted before the order is released to Ingram Micro’s warehouse. The order cannot be canceled once it is released to the warehouse. Order should be on customer hold to delete any order from Ingram system.", "operationId" : "delete-ordercancel", "security" : [ { "application" : [ "read" ] } ], "parameters" : [{ "name" : "OrderNumber", "in" : "path", "description" : "Ingram Micro sales order number.", "required" : true, "schema" : { "type" : "string", "example" : "20-RD128" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } } ], "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", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { } }, "400" : { "description" : "Bad Request", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "id" : "74681b27-b1ea-454d-9847-d27059e19119", "1ype" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "Country Code", "message" : "Country Code is missing." } ] } ] } } } } } }, "404" : { "description" : "Not Found", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "404 - Not Found" : { "value" : { "errors" : [ { "id" : "74681b27-b1ea-454d-9847-d27059e19119", "type" : "/errors/validation-error", "message" : "Order not found." } ] } } } } } }, "405" : { "description" : "Method Not Allowed", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "405 - Method Not Allowed" : { "value" : { "errors" : [ { "id" : "74681b27-b1ea-454d-9847-d27059e19119", "type" : "/errors/validation-error", "message" : "Order can not be deleted as the order is not no hold." } ] } } } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "500 - Internal Server Error" : { "value" : { "errors" : [ { "id" : "74681b27-b1ea-454d-9847-d27059e19119", "type" : "/errors/server-error", "message" : "ConnectivityIssue/ERP issue Contact Ingram Micro API Support. " } ] } } } } } } } } }, "/resellers/v7/vendorrequiredinfo" : { "post" : { "summary" : "Vendor Required Info", "tags" : [ "Orders v7" ], "description" : "Use this endpoint to identify vendor-mandated fields required before submitting an order request. These fields, also referred to as Vendor Mandatory Fields (VMFs) or Vendor Required Information (VRI), are required by the vendor to process the order. This endpoint can be used across the product catalog to retrieve required fields for standard Order Create, Configure to Order (CTO), and cloud ordering scenarios.\n\nYou can retrieve vendor-required fields using any of the following identifiers:\n- Ingram Micro part number\n- Vendor part number\n- Plan ID\n- Ingram Micro quote number\n\n For non-cloud Technology Solutions products, such as hardware, software, and warranty, required fields are returned in the `vmfAdditionalAttributes` object. For cloud products, required fields are returned in the `vriAdditionalAttributes` object.\n\nWhen submitting a request for standard Order Create or CTO for non-cloud products, include the `vmfAdditionalAttributes` object and provide the required values in the `attributeValue` field. For cloud ordering, include the `vriAdditionalAttributes` object and provide the required values in the `attributeValue` field, along with any other applicable subcomponents required to complete the order.", "operationId" : "vendor-required-info", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "US" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. ", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VendorRequiredInfoRequest" } } } }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorRequiredInforesponse" }, "examples": { "SampleresponseTSProduct": { "value": [ { "quoteNumber": "", "ingramPartNumber": "5DV320", "vendorPartNumber": "", "planId": "", "planName": "", "responseMessages": [], "vmfAdditionalAttributes": [ { "vendorName": "OMNISSA WS1", "additionalAttributes": [ { "attributeName": "HEADER_ENDUSER", "attributeValue": "", "attributeDescription": "HeaderEndUser", "choices": [] }, { "attributeName": "VEUD_AUTH_NBR_FLG", "attributeValue": "", "attributeDescription": "Authorization Number", "choices": [] } ] } ], "vriAdditionalAttributes": [] } ] }, "SampleresponseCloudsubscriptionProduct": { "value":[ { "quoteNumber": "", "ingramPartNumber": "", "vendorPartNumber": "", "planId": "438308", "planName": "Microsoft 365 F3 (NCE COM MTH)", "responseMessages": [], "vmfAdditionalAttributes": [], "vriAdditionalAttributes": [ { "vendorName": "Microsoft", "productId": "PRD-814-505-018", "additionalAttributes": [ { "attributeName": "tier1_mpn", "attributeValue": "5068860", "attributeDescription": "Microsoft Partner Number", "choices": [] }, { "attributeName": "tenant_preference", "attributeValue": "new,existing", "attributeDescription": "Please select the desired option for the CSP account", "choices": [ { "attributeValue": "new", "attributeDescription": "Create new Microsoft CSP end customer account", "choices": [ { "attributeName": "microsoft_domain", "attributeValue": "onmicrosoft.com", "attributeDescription": "Microsoft Domain Name", "attributeHint": "Up to 27 characters long", "choices": [] }, { "attributeName": "effective_address", "attributeValue": "", "attributeDescription": "Address Line 1", "choices": [] }, { "attributeName": "effective_city", "attributeValue": "", "attributeDescription": "City", "choices": [] }, { "attributeName": "effective_state", "attributeValue": "", "attributeDescription": "State or Province or Region", "choices": [] }, { "attributeName": "effective_postal_code", "attributeValue": "", "attributeDescription": "ZIP or Postal Code", "choices": [] }, { "attributeName": "effective_country", "attributeValue": "", "attributeDescription": "Country", "choices": [] }, { "attributeName": "mca_acceptance", "attributeValue": "yes,no", "attributeDescription": "MCA Acceptance", "attributeHint": "", "choices": [] }, { "attributeName": "first_name_agreement", "attributeValue": "", "attributeDescription": "Customer first name for Agreement", "attributeHint": "Please specify a valid Customer first name for the Agreement", "choices": [] }, { "attributeName": "last_name_agreement", "attributeValue": "", "attributeDescription": "Customer last name for Agreement", "attributeHint": "Please specify a valid Customer Last Name for the Agreement.", "choices": [] }, { "attributeName": "email_address_agreement", "attributeValue": "", "attributeDescription": "Email Address", "attributeHint": "", "choices": [] }, { "attributeName": "agreement_date", "attributeValue": "", "attributeDescription": "Microsoft Customer Agreement Date", "attributeHint": "Please add the date when the Microsoft Customer Agreement was accepted. (MM-DD-YYYY)", "choices": [] }, { "attributeName": "effective_phonenumber", "attributeValue": "", "attributeDescription": "Phone Number", "attributeHint": "", "choices": [] }, { "attributeName": "partner_on_record_attestation_accepted", "attributeValue": "attestation_accepted", "attributeDescription": "Partner on Record Attestation", "choices": [] }, { "attributeName": "special_qualifications", "attributeValue": "None,StateOwnedEntity", "attributeDescription": "State Owned Entity Attestation", "attributeHint": "Please choose the customer's eligible qualification.", "choices": [] }, { "attributeName": "address_approved_by_user", "attributeValue": "approved", "attributeDescription": "Address Approved by User", "choices": [] } ] }, { "attributeValue": "existing", "attributeDescription": "Use an existing Microsoft CSP end customer account", "choices": [ { "attributeName": "microsoft_domain", "attributeValue": "onmicrosoft.com", "attributeDescription": "Microsoft Domain Name", "attributeHint": "Up to 27 characters long", "choices": [] }, { "attributeName": "relationship_url", "attributeValue": "yes,no", "attributeDescription": "Confirm if the customer-partner authorization is done.", "attributeHint": "", "choices": [] }, { "attributeName": "partner_on_record_attestation_accepted", "attributeValue": "attestation_accepted", "attributeDescription": "Partner on Record Attestation", "choices": [] } ] } ] }, { "attributeName": "indirect_reseller_domain", "attributeValue": "devtestpablogarcia.onmicrosoft.com", "attributeDescription": "Indirect Reseller Domain", "attributeHint": "MyBusinessName.onmicrosoft.com", "choices": [] } ] } ] } ] } } } } } } } }, "/resellers/v6/quotes/create" : { "post" : { "summary" : "Quote Create", "tags" : [ "Quotes" ], "description" : "Use this endpoint to create a quote with an Ingram Micro part number or a vendor part number. For Configure to Order (CTO) quotes, provide a Special Bid number (Deal ID).\n\nIf the request is successful, the quote is automatically activated and moved to Ready to Order status.\n\n**Note:** CTO quote creation is currently supported only for Cisco. Cloud products are not supported at this time.\n\nWhen using a Deal ID, you must still include the products parameter in the request. However, do not include the productId, as the product will be applied to the quote automatically based on the deal.\n\nThe API returns an immediate confirmation when the quote is created successfully. Quote details are then sent through a webhook. If quote creation fails, the error details are also sent through a webhook.\n\nWebhook notifications apply to all quotes created through the Xvantage platform, APIs, associates, and other supported channels.", "operationId" : "quote_Create", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } } ], "requestBody": { "content": { "application/json": { "examples" : { "Quote Create With Deal" : { "value" : { "quoteName": "QuoteTest", "quoteExpiryDate": "04/30/2024", "customerNeed": "notes", "firstName": "User1", "lastName": "User name", "pricingType": "", "sendQuoteCopy": "", "customercontact": "kalimuthu.im@com", "dealId": "7499800", "endUserInfo": { "companyName": "Ingram Micro", "contact": "Test contact", "addressLine1": "Ratibor street", "addressLine2": "", "addressLine3": "", "city": "Ratibor", "state": "MI", "postalCode": "48502", "countryCode": "US", "email": "testcontact6@im.com", "phoneNumber": "64328753" }, "products": [] } }, "Standard Quote Create(Without Deal)" : { "value" : { "quoteName": "QuoteCreateNoDeal", "quoteExpiryDate": "04/30/2024", "customerNeed": "Customers special requirements notes", "firstName": "Jane", "lastName": "Doe", "endUserInfo": { "companyName": "Example Inc", "contact": "John Doe", "addressLine1": "100 Marine Ln", "addressLine2": "", "city": "Flint", "state": "MI", "postalCode": "48502", "countryCode": "US", "phoneNumber": "8767567560", "email": "jdoe@example.com" }, "pricingType": "y", "sendQuoteCopy": "y", "customercontact": "jane.doe@im.com", "products": [ { "ingramPartNumber": "03WK88", "quantity": "2" } ] } } }, "schema": { "$ref": "#/components/schemas/quote_create_request" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote_create_response" }, "examples": { "Quote Create With Deal" : { "value" : { "quoteNumber": "QUO-19104665-K1B3Y6", "message": "Thank you for submitting the quote request, it’s currently under process.We will notify you of the status via the Quote Status webhook." } }, "Standard Quote Create(Without Deal)" : { "value" : { "quoteNumber": "QUO-19108656-W8Q2M0", "message": "Thank you for submitting the quote request, it’s currently under process.We will notify you of the status via the Quote Status webhook." } }, "200": { "description": "", "value": { "quoteNumber": "QUO-2081293-G9X1K5", "message": "Thank you for submitting the quote request, it’s currently under process.We will notify you of the status via the Quote Status webhook." } } } } } }, "201": { "description": "Webhook Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quote_create_webhook_response" }, "examples": { } } } } } } }, "/resellers/v6/quotes/search" : { "get" : { "summary" : "Quote Search", "tags" : [ "Quotes" ], "description" : "The Quote Search API, by default, will retrieve quotes modified or created within the last 30 days. Quote Search by date range enables the retrieval of quotes older than 30 days and up to 365 days. Quotes older than 365 days are excluded. The Quote Search API enables the retrieval and filtering of relevant quote list key criteria data such as Quote Number, Quote Name, Deal ID (Special Bid Numbers), End User Name, and Vendor Name. Utilizing search any portion of a string can be used to search and retrieve related quotes from Ingram Micro’s quote services. The following quotes are available: IngramMicro Sales Team Created Quotes – Active Status, Vendor Integration Quotes for Cisco and Dell, both Active and Draft Status, Self Service - X4C reseller created Quotes – Active and Draft Status, Subscription Quotes – Draft and Active Status, Renewal Quotes Active Status, Cloud Quotes- Active Status. Hybrid Quotes – Active Status, Closed/Ordered Quotes All Quote Types \n\n The Quote Search response will return the following information: Created Date, Quote ID, Quote Name, Created by, End Customer, Deal (deal id), Vendor (vendor name), Total Price, Last Updated, Expiration Date, Status \n\n Once identified – requesting quote details will return all details related to the quote information. \n\n **Enhancements:** \n\n With this enhancement, new filters will be added to the request along with more data fields in the response. (see the table below for the request and response both with the enhancements for more details.)", "operationId" : "get-quotessearch_v6", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "quoteNumber", "in" : "query", "description" : "Unique identifier generated by Ingram Micros CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes.", "required" : false, "schema" : { "type" : "string", "example" : "QUO-10985-C4C3F7" } }, { "name" : "specialBidNumber", "in" : "query", "description" : "Special Pricing Bid Number, also referred to as a Dart Number by some vendors, is a unique identifier associated with vendor specific products and discounts.", "required" : false, "schema" : { "type" : "string", "example" : "9638445-1880" } }, { "name" : "endUserContact", "in" : "query", "description" : "End User Name is the end customer name that is associated with a quote in Ingram Micros CRM.", "required" : false, "schema" : { "type" : "string", "example" : "JD Enterprises" } }, { "name" : "sortingOrder", "in" : "query", "description" : "Sort applies to the selected column (sortingColumnName) and may be specified in Ascending (asc) or Descending (desc) order. The default sort is Descending (desc) - most recent first.", "required" : false, "schema" : { "type" : "string", "example" : "desc" } }, { "name" : "sortBy", "in" : "query", "description" : "Refers to the column selected to apply the sorting criteria. The default column is dateCreated and will sort by the most recently created quote first with the following in descending order. The default filter retrieves quotes created within the last 30 days. Filtering allows user to select a specific column to sort: quoteNumber, createdDate, lastModifiedDate and expiryDate.", "required" : false, "schema" : { "type" : "string", "example" : "quoteNumber" } }, { "name" : "pageSize", "in" : "query", "description" : "Number of records (quotes) to display per page in the quote list. The default is 25, but may be decreased using the filter .", "required" : false, "schema" : { "type" : "integer", "example" : 25 } }, { "name" : "pageNumber", "in" : "query", "description" : "Page index or page number for the list of quotes being returned.", "required" : false, "schema" : { "type" : "integer", "default" : 1 } }, { "name" : "vendorName", "in" : "query", "description" : "The name of the vendor.", "required" : false, "schema" : { "type" : "string", "example" : "Dell" } }, { "name" : "quoteName", "in" : "query", "description" : "The quote name was given by the customer while creating quote.", "required" : false, "schema" : { "type" : "string", "example":"MyQuote" } }, { "name" : "status", "in" : "query", "description" : "The status of the quote.", "required" : false, "schema" : { "type" : "string", "example" : "Ready to Order" } }, { "name" : "quoteCreateDate-bt", "in" : "query", "description" : "Search with start and end date(only 2 entries allowed).", "required" : false, "schema" : { "type" : "string" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CustomerContact", "in" : "header", "description" : "Logged in Users email address contact.", "required" : true, "schema" : { "type" : "string", "maxLength" : 64, "example" : "John.Doe@reseller.com" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } } ], "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", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteSearchResponse" }, "examples" : { "SampleResponse" : { "value" : { "recordsFound" : 4, "pageSize" : 25, "pageNumber" : 1, "quotes" : [ { "quoteGuid" : "30786810-d7e8-e911-a97b-000d3a30e34c", "quoteName" : "Test Quote - 999", "quoteNumber" : "QUO-10985-C4C3F7", "revision" : "1", "endUserContact" : "test", "createdBy" : "Ingram Micro", "specialBidNumber" : null, "vendor" : "ABC SERIES", "quoteTotal" : 400.03, "quoteStatus" : "Active", "ingramQuoteDate" : "2019-10-07", "lastModifiedDate" : "2020-01-10", "ingramQuoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "88f0efdc-53e5-e911-a97b-000d3a30e34c", "quoteName" : "Test1", "quoteNumber" : "QUO-10637-W4M3G1", "revision" : "0", "endUserContact" : null, "createdBy" : "Ingram Micro", "specialBidNumber" : null, "vendor" : "ABC SERIES", "quoteTotal" : 0, "quoteStatus" : "Active", "ingramQuoteDate" : "2019-10-02", "lastModifiedDate" : "2019-10-02", "ingramQuoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "02bdecfd-33e1-e911-a97a-000d3a30eb04", "quoteName" : "MSJ Singapore Test 02", "quoteNumber" : "QUO-10477-X9M2N4", "revision" : "0", "endUserContact" : null, "createdBy" : "Ingram Micro", "specialBidNumber" : null, "vendor" : "ABC SERIES", "quoteTotal" : 11642.1, "quoteStatus" : "Active", "ingramQuoteDate" : "2019-09-27", "lastModifiedDate" : "2019-09-27", "ingramQuoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "994690a2-33e1-e911-a97a-000d3a30eb04", "quoteName" : "MSJ Singapore Test 01", "quoteNumber" : "QUO-10475-S4M1N0", "revision" : "0", "endUserContact" : null, "createdBy" : "Ingram Micro", "specialBidNumber" : null, "vendor" : "ABC SERIES", "quoteTotal" : 11902.38, "quoteStatus" : "Active", "ingramQuoteDate" : "2019-09-27", "lastModifiedDate" : "2019-09-27", "ingramQuoteExpiryDate" : "0001-01-01" } ] } } } } } }, "400" : { "description" : "Bad Request", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Multiple Errors" : { "value" : { "errors" : [ { "id" : "-bw0a10t1-2021-02-19T11:04:37.312-08:00", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "20-22222222", "message" : "IM-CustomerNumber must be in the format XX-XXXXXX" }, { "field" : "IM-CorrelationID", "value" : "", "message" : "IM-CorrelationID cannot be blank" } ] } ] } } } } } }, "401" : { "description" : "Unauthorized" }, "404" : { "description" : "Not Found", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "No records found" : { "value" : { "errors" : [ { "id" : "-bw0a10t1-2021-02-19T11:04:37.312-08:00", "type" : "/errors/validation-failed", "message" : "No records found for the provided criteria." } ] } } } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-SenderID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "C123-bw0a10u3-2021-02-19T11:12:26.436-08:00", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred, please contact support team for more details." } ] } } } } } } } } }, "/resellers/v6/quotes/{quoteNumber}" : { "get" : { "summary" : "Get Quote Details", "tags" : [ "Quotes" ], "description" : "The quote details API provides all quote details associated with the quote number provided.\n\nThe **“quoteNumber”**, **“isoCountryCode”** and **“customerNumber”** parameters are required. ", "operationId" : "get-resellers-v6-quotes", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your Ingram Micro unique customer number", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique identifier used to identify the third party source accessing the services.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "ASJDasbjdn-asjnd12dalks-asjkn" } }, { "name" : "quoteNumber", "in" : "path", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes.", "required" : true, "schema" : { "type" : "string", "example" : "QUO-10926-Y8G1B3" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteDetailsResponse" }, "examples" : { "Success" : { "value" : { "quoteName" : "Q3", "quoteNumber" : "QUO-10926-Y8G1B3", "revision" : "0", "ingramQuoteDate" : "2019-10-04T18:17:28Z", "lastModifiedDate" : "2019-10-04T19:12:03Z", "currencyCode" : "USD", "specialBidId" : "TEST-9771006-1923", "specialBidExpirationDate" : "2020-01-01T00:00:00", "status" : "Active", "customerNeed" : "Customer Need", "introPreamble" : "#####Thank you for contacting Ingram Micro. We value your business greatly and will continue to deliver the services you need to retain it. This quote is not intended to represent the entire conversation; only what was relevant to the solution you requested. We make every effort to provide a complete and correct solution. However, the accuracy of the solution provided is dependent on the information gathered. If relevant information is not provided by our customer, Ingram Micro cannot be held responsible. We urge you to review this quote fully, to ensure it reflects all of your required specifications. If you have additional questions, please contact your designated Ingram Micro contact. Remember to reference your Quote Number.#####Call reference #
To ensure fastest and most accurate processing of your order, please provide the quote# at the time of purchase", "purchaseInstructions" : "For specific pricing and to order the above products, you may \r\n\r\n • Some product may be orderable on Imonline at http://us-new.ingrammicro.com\r\n\r\n • Call the Ingram Micro Sales department at 1.800.456.8000\r\n* Your PO number *End User\r\n* Your fax number\r\n* Shipping instructions\r\n* End user PO number\r\n* End user license, contract or authorization number\r\n\r\nThank you for your order!", "legalTerms" : "This offer to sell the listed product(s) is subject to product availability and Ingram Micro's standard terms and conditions that are published on http://www.ingrammicro.com prices are subject to change without notice.\r\nPlease contact the Ingram Micro Sales desk at 1.800.456.8000 if you have any additional questions.", "leaseInfo" : "", "leasingInstructions" : "", "resellerInfo" : { "contact" : "INGRAM MICRO ITSOLUTIONS LLC Contact3 INGRAM MICRO ITSOLUTIONS LLC last name3", "companyName" : "INGRAM MICRO IT SOLUTIONS LLC", "email" : "TestQuote3@INGRAMMICROITSOLUTIONS.com", "phoneNumber" : "9999999000", "customerNumber" : "20-222222" }, "endUserInfo" : { "companyName" : "End User3" }, "products" : [ { "quoteProductGuid" : "f428080c-9319-ee11-8f6e-000d3a34da18", "lineNumber" : "2a2fb5df-46a6-485e-903e-c025dc2216b6", "quantity" : 1, "ean" : "-", "coo" : " ", "ingramPartNumber" : "9DD701", "vendorPartNumber" : "CBL-PWR-C15-C14-US", "description" : "POWER CORD FOR EX4300 US", "weight" : 0, "isSuggestionProduct" : false, "terms" : "--", "price" : { "quotePrice" : 122.5, "msrp" : 175, "extendedMsrp" : 175, "extendedQuotePrice" : 122.5, "discountOffList" : "0.00" } } ], "productsCount" : 1, "extendedMsrpTotal" : 12000, "quantityTotal" : 10, "extendedQuotePriceTotal" : 10000, "additionalAttributes" : [ { "attributeName" : "estimateId", "attributeValue" : "DO85027550IK" }, { "attributeName" : "dealId", "attributeValue" : "123456" } ] } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "CustomerNumber format incorrect" : { "value" : { "errors" : [ { "id" : "1629203530223-2021-08-17T18:02:10.21+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "20222222", "message" : "IM-CustomerNumber must be in the format xx-xxxx or xx-xxxxx or xx-xxxxxx" } ] } ] } }, "CustomerNumber blank" : { "value" : { "errors" : [ { "id" : "1629204354596-2021-08-17T18:15:54.596+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "", "message" : "IM-CustomerNumber is blank" } ] } ] } }, "CountryCode invalid" : { "value" : { "errors" : [ { "id" : "1629204465806-2021-08-17T18:17:45.806+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "UU", "message" : "IM-CountryCode is invalid" } ] } ] } }, "Multiple error" : { "value" : { "errors" : [ { "id" : "1629204746878-2021-08-17T18:22:26.867+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "UU", "message" : "IM-CountryCode is invalid" }, { "field" : "IM-CustomerNumber", "value" : "", "message" : "IM-CustomerNumber is blank" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Unexpected Error" : { "value" : { "errors" : [ { "id" : "1629204961192-2021-08-17T18:26:01.191+05:30-bw0a103", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred, please contact support team for more details " } ] } } } } } } } } }, "/resellers/v6/invoices/" : { "get" : { "summary" : "Search your invoice", "tags" : [ "Invoices" ], "description" : "Search your Ingram Micro invoices. This endpoint searches by multiple invoice parameters and supports pagination of results.", "operationId" : "get-resellers-v6-invoicesearch", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-ApplicationID ", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222", "maxLength" : 10 } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "example" : "US", "maxLength" : 2, "minLength" : 2 } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "paymentTermsNetDate", "in" : "query", "description" : "Search by payment terms net date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "invoiceDate", "in" : "query", "description" : "Search by invoice date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "invoiceDueDate", "in" : "query", "description" : "Search by invoice date from(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "orderDate", "in" : "query", "description" : "Search by OrderDate date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "orderFromDate", "in" : "query", "description" : "Search by OrderFromDate date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "orderToDate", "in" : "query", "description" : "Search by OrderToDate date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "orderNumber", "in" : "query", "description" : "Search by order number", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "DeliveryNumber", "in" : "query", "description" : "Search by delivery number.", "required" : false, "schema" : { "type" : "string", "example" : "335238411" } }, { "name" : "invoiceNumber", "in" : "query", "description" : "The Ingram Micro invoice number.", "required" : false, "schema" : { "type" : "string", "maxLength" : 11 } }, { "name" : "invoiceStatus", "in" : "query", "description" : "Ingram Micro invoice status.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "invoiceType", "in" : "query", "description" : "Ingram Micro InvoiceType.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "customerOrderNumber", "in" : "query", "description" : "Ingram Micro CustomerOrderNumber.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "endCustomerOrderNumber", "in" : "query", "description" : "Ingram Micro EndCustomerOrderNumber.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "specialBidNumber", "in" : "query", "description" : "Ingram Micro SpecialBidNumber.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "invoiceFromDueDate", "in" : "query", "description" : "Search by invoice due date from(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "invoiceToDueDate", "in" : "query", "description" : "Search by invoice due date to(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "invoiceFromDate", "in" : "query", "description" : "Search by invoice date from(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "items" : { "type" : "string", "example" : "2021-04-23" } } }, { "name" : "invoiceToDate", "in" : "query", "description" : "Search by invoice date To(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "items" : { "type" : "string", "example" : "2021-04-23" } } }, { "name" : "pageSize", "in" : "query", "description" : "Number of records required in the call - max records 100 per page.", "required" : false, "schema" : { "type" : "integer", "default" : "25", "format" : "int32" } }, { "name" : "pageNumber", "in" : "query", "description" : "The page number reference.", "required" : false, "schema" : { "type" : "integer", "default" : "1", "format" : "int32" } }, { "name" : "orderby", "in" : "query", "description" : "Column name with which we want to sort.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "InvoiceDate" } }, { "name" : "direction", "in" : "query", "description" : "asc or desc , along with orderby column result set will be sorted.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "desc" } }, { "name" : "serialNumber", "in" : "query", "description" : "Serial number of the product.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32 } } ], "responses" : { "200" : { "description" : "InvoiceSearchResponse to be returned", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceSearchResponse" }, "examples" : { "Success - 200" : { "value" : { "invoices" : [ { "paymentTermsDueDate" : "2022-11-10", "erpOrderNumber" : "40-MKTRW-11", "invoiceAmountInclTax" : 85.23, "invoiceNumber" : "40MKTRW11", "invoiceStatus" : "OPEN", "invoiceDate" : "2022-10-29", "invoiceDueDate" : "2022-11-10", "invoicedAmountDue" : 243.16, "customerOrderNumber" : "ZBJ3724", "endCustomerOrderNumber" : "NFP259", "orderCreateDate" : "2022-10-27" } ], "nextPage" : "/resellers/v6/invoices/?customerNumber=40-017165&invoiceFromDate=5/3/2022&invoiceToDate=10/30/2022&page=1&size=10&orderBy=invoiceDate&direction=desc&pageNumber=2", "recordsFound" : 89701, "pageSize" : 10, "pageNumber" : 1 } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "traceid" : "1", "type" : "errors/bad-request", "message" : "Input passed is not in right or expected format. Model Binding Error Happens at Global Model Binding Exception Handler.", "fields" : [ { "field" : "IM-CountryCode", "message" : "The countryCode field is required.", "value" : null } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "traceid" : "121", "type" : "System.Net.WebException", "message" : "Error while processing request for 1121,for SiteCode sg,for CorrelationId :121 , Message :The remote server returned an error: (404) Not Found.", "fields" : [ ] } ] } } } } } } } } }, "/resellers/v6/invoices/{invoicenumber}" : { "get" : { "summary" : "Get Invoice Details v6", "tags" : [ "Invoices v6" ], "description" : "Use your Ingram Micro invoice number to search for existing invoices or retrieve existing invoice details.\n\nThe invoice number, IM-CustomerNumber, IM-CountryCode, IM-ApplicationId and IM-CorrelationID are required parameters.\n\n.", "operationId" : "get-invoicedetails-v6", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "invoicenumber", "in" : "path", "description" : "The Ingram Micro invoice number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 12, "example" : "335238411" } }, { "name" : "version", "in" : "header", "description" : "Version of codebase.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-ApplicationID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "customerType", "in" : "query", "description" : "it should be invoice or order", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "invoice" } }, { "name" : "includeSerialNumbers", "in" : "query", "description" : "if serial in the response send as true or else false", "required" : false, "schema" : { "type" : "boolean", "example" : "false" } } ], "responses" : { "200" : { "description" : "OK", "headers" : { "IM-CorrelationID" : { "schema" : { "type" : "string" }, "description" : "Unique transaction number to identify each transaction across all the systems." }, "IM-ApplicationID" : { "schema" : { "type" : "string", "example" : "MyCompany" }, "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceDetailResponse" }, "examples" : { "Success" : { "value" : { "InvoiceNumber" : "40-DPJ17-11", "InvoiceDate" : "2022-09-07", "OrderDate" : "2022-09-07", "IngramPurchaseOrderNumber" : "70GZJ35", "InvoiceType" : "Invoice", "InvoiceDueDate" : "2022-10-22", "IngramInvoiceNumber" : "", "Notes" : "HEADER || H:1427214", "PaymentTermsInfo" : { "PaymentTermsCode" : "45", "PaymentTermsDescription" : "NET 45 DAYS", "PaymentTermsDueDate" : "2022-10-22" }, "BillToInfo" : { "CompanyName" : "SOFTWARE ONE INC", "AddressLine1" : "20875 CROSSROADS CIR", "City" : "WAUKESHA", "State" : "WI", "PostalCode" : "531864052" }, "ShipToInfo" : { "CompanyName" : "RITE-HITE CORPORATION", "AddressLine1" : "8900 N ARBON DR", "City" : "MILWAUKEE", "State" : "WI", "PostalCode" : "532230000" }, "Lines" : [ { "IngramLineNumber" : "12", "CustomerLineNumber" : "1", "IngramPartNumber" : "05QC29", "VendorPartNumber" : "65324394AD01A00", "VendorName" : "ADOBE COMMERCIA", "ProductDescription" : "AOO LICS ACROBAT PRO 2020 MPLATLICS || 1+ 540PT", "UnitWeight" : "0.0", "Quantity" : 1, "UnitPrice" : 533.33, "UnitOfMeasure" : "EA", "CurrencyCode" : "USD", "ExtendedPrice" : 533.33, "TaxPercentage" : 0, "taxPercentage" : 0, "TaxAmount" : 0, "serialNumbers" : [ { "serialNumber" : "0AMY3CPRA00359" }, { "serialNumber" : "0AMY3CPRA00484" }, { "serialNumber" : "0AMY3CPRA00485" }, { "serialNumber" : "0AMY3CPRA00479" }, { "serialNumber" : "0AMY3CPRA00486" }, { "serialNumber" : "0AMY3CPRA00480" }, { "serialNumber" : "0AMY3CPRA00465" }, { "serialNumber" : "0AMY3CPRA00481" }, { "serialNumber" : "0AMY3CPRA00483" }, { "serialNumber" : "0AMY3CPRA00493" }, { "serialNumber" : "0AMY3CPRA00476" } ], "QuantityOrdered" : 1, "QuantityShipped" : 1 } ], "EndUserInfo" : { "Contact" : "RITE-HITE CORPORATION", "AddressLine1" : "8900 N ARBON DR", "AddressLine2" : "", "City" : "MILWAUKEE", "State" : "WI", "PostalCode" : "532232451", "CountryCode" : "US", "PhoneNumber" : "14143624491", "Email" : "MPOWERS@RITEHITE.COM" }, "FxRateInfo" : { "CurrencyCode" : "USD", "CompanyCurrency" : "USD", "InvoiceCurrency" : "USD", "CurrencyFxRate" : 1 }, "Summary" : { "Lines" : { "ProductLineCount" : 1, "ProductLineTotalQuantity" : 1 }, "MiscCharges" : [ { "ChargeDescription" : "STATETAX", "MiscChargeLineCount" : 0, "MiscChargeLineTotal" : 355.83, "ChargeLineReference" : "GST" }, { "ChargeDescription" : "FREIGHT OUT", "MiscChargeLineCount" : 1, "MiscChargeLineTotal" : 31.9, "ChargeLineReference" : "8" } ], "Totals" : { "NetInvoiceAmount" : 533.33, "DiscountAmount" : 0, "DiscountType" : "Terms Charge", "InvoicedAmountDue" : 533.33 }, "ForeignFxTotals" : { "ForeignCurrencyCode" : "USD", "ForeignCurrencyFxRate" : 1, "ForeignTotalTaxableAmount" : "533.33", "ForeignTotalTaxAmount" : 0, "ForeignInvoiceAmountDue" : "533.33" } } } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "CustomerNumber format incorrect" : { "value" : { "errors" : [ { "id" : "1629203530223-2021-08-17T18:02:10.21+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "20222222", "message" : "IM-CustomerNumber must be in the format xx-xxxx or xx-xxxxx or xx-xxxxxx" } ] } ] } }, "CustomerNumber blank" : { "value" : { "errors" : [ { "id" : "1629204354596-2021-08-17T18:15:54.596+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "", "message" : "IM-CustomerNumber is blank" } ] } ] } }, "CountryCode invalid" : { "value" : { "errors" : [ { "id" : "1629204465806-2021-08-17T18:17:45.806+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "UU", "message" : "IM-CountryCode is invalid" } ] } ] } }, "Multiple error" : { "value" : { "errors" : [ { "id" : "1629204746878-2021-08-17T18:22:26.867+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "UU", "message" : "IM-CountryCode is invalid" }, { "field" : "IM-CustomerNumber", "value" : "", "message" : "IM-CustomerNumber is blank" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "1", "type" : "InternalServerError", "message" : "Un-handled Exception \n Please contact to administrator." } ] } } } } } } } } }, "/resellers/v6.1/invoices/{invoiceNumber}" : { "get" : { "summary" : "Get Invoice Details v6.1", "tags" : [ "Invoices" ], "description" : "Use your Ingram Micro invoice number to search for existing invoices or retrieve existing invoice details.\n\nThe invoice number, IM-CustomerNumber, IM-CountryCode, IM-ApplicationId and IM-CorrelationID are required parameters.\n\n.", "operationId" : "get-invoicedetails-v6.1", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "invoiceNumber", "in" : "path", "description" : "The Ingram Micro invoice number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 12, "example" : "335238411" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-ApplicationID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "customerType", "in" : "query", "description" : "it should be invoice or order", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "invoice" } }, { "name" : "includeSerialNumbers", "in" : "query", "description" : "if serial in the response send as true or else false", "required" : false, "schema" : { "type" : "boolean", "example" : "false" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceDetailsv6.1Response" }, "examples" : { "Success" : { "value" : { "invoiceNumber" : "40-DPJ17-11", "invoiceStatus" : "Open", "invoiceDate" : "2022-09-07", "customerOrderNumber" : "6593806021209101", "endCustomerOrderNumber" : "XPO37686", "orderDate" : "2022-09-07", "billToID" : "000", "invoiceType" : "Invoice", "invoiceDueDate" : "2022-10-22", "customerCountryCode" : "US", "customerNumber" : "20-222222", "ingramOrderNumber" : "40-25436-11", "notes" : "HEADER || H:1427214", "paymentTermsInfo" : { "paymentTermsCode" : "45", "paymentTermsDescription" : "NET 45 DAYS", "paymentTermsDueDate" : "2022-10-22" }, "billToInfo" : { "companyName" : "DELL MARKETING LP", "addressLine1" : "1 DELL WAY", "addressLine2" : "BUSINESS SALES", "city" : "ROUND ROCK", "state" : "TX", "postalCode" : "786827000", "countryCode" : "US" }, "shipToInfo" : { "contact" : "ALVARADO ALICIA", "companyName" : "USA-EL PASO-1851 RESLER DRIVE", "addressLine1" : "1851 RESLER DR", "city" : "EL PASO", "state" : "TX", "postalCode" : "799120000", "countryCode" : "US" }, "lines" : [ { "ingramLineNumber" : "12", "customerLineNumber" : "1", "ingramPartNumber" : "05QC29", "vendorPartNumber" : "65324394AD01A00", "vendorName" : "ADOBE COMMERCIA", "productDescription" : "AOO LICS ACROBAT PRO 2020 MPLATLICS || 1+ 540PT", "unitWeight" : "0.0", "quantity" : 1, "unitPrice" : 533.33, "unitOfMeasure" : "EA", "currencyCode" : "USD", "extendedPrice" : 533.33, "taxPercentage" : 0, "taxRate" : 0, "taxAmount" : 0, "serialNumbers" : [ { "serialNumber" : "2TEPYT" }, { "serialNumber" : "2TER09" } ], "quantityOrdered" : 1, "quantityShipped" : 1 } ], "endUserInfo" : { "contact" : "ABC CORPORATION", "addressLine1" : "1 N ARBON DR", "addressLine2" : "", "city" : "MILWAUKEE", "state" : "WI", "postalCode" : "532232451", "countryCode" : "US", "phoneNumber" : "14143624491", "email" : "ABC@GMAIL.COM" }, "fxRateInfo" : { "currencyCode" : "USD", "companyCurrency" : "USD", "invoiceCurrency" : "USD", "currencyFxRate" : 1 }, "summary" : { "lines" : { "productLineCount" : 1, "productLineTotalQuantity" : 1 }, "miscCharges" : [ { "chargeDescription" : "TAX", "miscChargeLineCount" : 0, "miscChargeLineTotal" : 355.83, "chargeLineReference" : "" }, { "chargeDescription" : "FREIGHT OUT", "miscChargeLineCount" : 1, "miscChargeLineTotal" : 31.9, "chargeLineReference" : "8" } ], "totals" : { "netInvoiceAmount" : 533.33, "discountAmount" : 0, "discountType" : "Terms Charge", "totalTaxAmount" : 0, "invoicedAmountDue" : 533.33 }, "foreignFxTotals" : { "foreignCurrencyCode" : "USD", "foreignCurrencyFxRate" : 1, "foreignTotalTaxableAmount" : "533.33", "foreignTotalTaxAmount" : 0, "foreignInvoiceAmountDue" : "533.33" } } } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "CustomerNumber format incorrect" : { "value" : { "errors" : [ { "id" : "1629203530223-2021-08-17T18:02:10.21+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "20222222", "message" : "IM-CustomerNumber must be in the format xx-xxxx or xx-xxxxx or xx-xxxxxx" } ] } ] } }, "CustomerNumber blank" : { "value" : { "errors" : [ { "id" : "1629204354596-2021-08-17T18:15:54.596+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "", "message" : "IM-CustomerNumber is blank" } ] } ] } }, "CountryCode invalid" : { "value" : { "errors" : [ { "id" : "1629204465806-2021-08-17T18:17:45.806+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "UU", "message" : "IM-CountryCode is invalid" } ] } ] } }, "Multiple error" : { "value" : { "errors" : [ { "id" : "1629204746878-2021-08-17T18:22:26.867+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "UU", "message" : "IM-CountryCode is invalid" }, { "field" : "IM-CustomerNumber", "value" : "", "message" : "IM-CustomerNumber is blank" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "1", "type" : "InternalServerError", "message" : "Un-handled Exception \n Please contact to administrator." } ] } } } } } } } } }, "/resellers/v7/invoices/{invoiceNumber}" : { "get" : { "summary" : "Get Invoice Details v7", "tags" : [ "Invoices v7" ], "description" : "Retrieve the complete billing record for a specific invoice by passing the invoice number returned from Invoice Search v7. Returns full line-item detail including product descriptions, quantities, unit and extended pricing, tax breakdown, freight charges, payment terms, and due date — everything needed for payment processing, reconciliation, and billing dispute resolution.\n\nImportant — invoice type scope: Invoice Details v7 returns the record for either a Technology Solution (TS) invoice or a Cloud Solution (CS) invoice, depending on the IM-CustomerNumber passed in the request header. It does not combine both in a single response. Ensure the customer number used matches the line of business the invoice belongs to, otherwise the request will return no results.\n\nPrerequisite: This endpoint requires an exact Ingram Micro invoice number. If you do not have the invoice number, use Invoice Search v7 first to locate it using a PO number, order number, date range, or other filter criteria, then pass the returned invoice number here.", "operationId" : "get-invoicedetails-v7", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "invoiceNumber", "in" : "path", "description" : "The Ingram Micro invoice number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 12, "example" : "335238411" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-ApplicationID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "customerType", "in" : "query", "description" : "it should be invoice or order", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "invoice" } }, { "name" : "includeSerialNumbers", "in" : "query", "description" : "if serial in the response send as true or else false", "required" : false, "schema" : { "type" : "boolean", "example" : "false" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceDetailsv6.1Response" }, "examples" : { "Ts Invoice Details" : { "value" : { "invoiceNumber" : "40-DPJ17-11", "invoiceStatus" : "Open", "invoiceDate" : "2022-09-07", "customerOrderNumber" : "6593806021209101", "endCustomerOrderNumber" : "XPO37686", "orderDate" : "2022-09-07", "billToID" : "000", "invoiceType" : "Invoice", "invoiceDueDate" : "2022-10-22", "customerCountryCode" : "US", "customerNumber" : "20-222222", "OrderNumber" : "40-25436-11", "notes" : "HEADER || H:1427214", "paymentTermsInfo" : { "paymentTermsCode" : "45", "paymentTermsDescription" : "NET 45 DAYS", "paymentTermsDueDate" : "2022-10-22" }, "billToInfo" : { "companyName" : "DELL MARKETING LP", "addressLine1" : "1 DELL WAY", "addressLine2" : "BUSINESS SALES", "city" : "ROUND ROCK", "state" : "TX", "postalCode" : "786827000", "countryCode" : "US" }, "shipToInfo" : { "contact" : "ALVARADO ALICIA", "companyName" : "USA-EL PASO-1851 RESLER DRIVE", "addressLine1" : "1851 RESLER DR", "city" : "EL PASO", "state" : "TX", "postalCode" : "799120000", "countryCode" : "US" }, "lines" : [ { "ingramLineNumber" : "12", "customerLineNumber" : "1", "ingramPartNumber" : "05QC29", "vendorPartNumber" : "65324394AD01A00", "vendorName" : "ADOBE COMMERCIA", "productDescription" : "AOO LICS ACROBAT PRO 2020 MPLATLICS || 1+ 540PT", "unitWeight" : "0.0", "quantity" : 1, "unitPrice" : 533.33, "unitOfMeasure" : "EA", "currencyCode" : "USD", "extendedPrice" : 533.33, "taxPercentage" : 0, "taxRate" : 0, "taxAmount" : 0, "serialNumbers" : [ { "serialNumber" : "2TEPYT" }, { "serialNumber" : "2TER09" } ], "quantityOrdered" : 1, "quantityShipped" : 1 } ], "endUserInfo" : { "contact" : "ABC CORPORATION", "addressLine1" : "1 N ARBON DR", "addressLine2" : "", "city" : "MILWAUKEE", "state" : "WI", "postalCode" : "532232451", "countryCode" : "US", "phoneNumber" : "14143624491", "email" : "ABC@GMAIL.COM" }, "fxRateInfo" : { "currencyCode" : "USD", "companyCurrency" : "USD", "invoiceCurrency" : "USD", "currencyFxRate" : 1 }, "summary" : { "lines" : { "productLineCount" : 1, "productLineTotalQuantity" : 1 }, "miscCharges" : [ { "chargeDescription" : "TAX", "miscChargeLineCount" : 0, "miscChargeLineTotal" : 355.83, "chargeLineReference" : "" }, { "chargeDescription" : "FREIGHT OUT", "miscChargeLineCount" : 1, "miscChargeLineTotal" : 31.9, "chargeLineReference" : "8" } ], "totals" : { "netInvoiceAmount" : 533.33, "discountAmount" : 0, "discountType" : "Terms Charge", "totalTaxAmount" : 0, "invoicedAmountDue" : 533.33 }, "foreignFxTotals" : { "foreignCurrencyCode" : "USD", "foreignCurrencyFxRate" : 1, "foreignTotalTaxableAmount" : "533.33", "foreignTotalTaxAmount" : 0, "foreignInvoiceAmountDue" : "533.33" } } } }, "Cs Invoice Details" : { "value" : { "invoiceNumber" : "40-DPJ17-11", "invoiceStatus" : "Open", "invoiceDate" : "2022-09-07", "customerOrderNumber" : "6593806021209101", "endCustomerOrderNumber" : "XPO37686", "orderDate" : "2022-09-07", "billToID" : "000", "invoiceType" : "Invoice", "invoiceDueDate" : "2022-10-22", "customerCountryCode" : "US", "customerNumber" : "20-222222", "OrderNumber" : "40-25436-11", "billToInfo" : { "companyName" : "DELL MARKETING LP", "addressLine1" : "1 DELL WAY", "addressLine2" : "BUSINESS SALES", "city" : "ROUND ROCK", "state" : "TX", "postalCode" : "786827000", "countryCode" : "US" }, "lines" : [ { "ingramLineNumber" : "12", "productDescription" : "AOO LICS ACROBAT PRO 2020 MPLATLICS || 1+ 540PT", "quantity" : 1, "unitPrice" : 533.33, "currencyCode" : "USD", "extendedPrice" : 533.33, "taxPercentage" : 0, "taxRate" : 0, "taxAmount" : 0, "quantityOrdered" : 1, "quantityShipped" : 1 } ], "endUserInfo" : { "contact" : "ABC CORPORATION", "addressLine1" : "1 N ARBON DR", "addressLine2" : "", "city" : "MILWAUKEE", "state" : "WI", "postalCode" : "532232451", "countryCode" : "US", "phoneNumber" : "14143624491", "email" : "ABC@GMAIL.COM" }, "summary" : { "lines" : { "productLineCount" : 1, "productLineTotalQuantity" : 1 }, "totals" : { "netInvoiceAmount" : 533.33, "discountAmount" : 0, "discountType" : "Terms Charge", "totalTaxAmount" : 0, "invoicedAmountDue" : 533.33 } } } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "CustomerNumber format incorrect" : { "value" : { "errors" : [ { "id" : "1629203530223-2021-08-17T18:02:10.21+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "20222222", "message" : "IM-CustomerNumber must be in the format xx-xxxx or xx-xxxxx or xx-xxxxxx" } ] } ] } }, "CustomerNumber blank" : { "value" : { "errors" : [ { "id" : "1629204354596-2021-08-17T18:15:54.596+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CustomerNumber", "value" : "", "message" : "IM-CustomerNumber is blank" } ] } ] } }, "CountryCode invalid" : { "value" : { "errors" : [ { "id" : "1629204465806-2021-08-17T18:17:45.806+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "UU", "message" : "IM-CountryCode is invalid" } ] } ] } }, "Multiple error" : { "value" : { "errors" : [ { "id" : "1629204746878-2021-08-17T18:22:26.867+05:30-123", "type" : "/errors/validation-failed", "message" : "Validation failed", "fields" : [ { "field" : "IM-CountryCode", "value" : "UU", "message" : "IM-CountryCode is invalid" }, { "field" : "IM-CustomerNumber", "value" : "", "message" : "IM-CustomerNumber is blank" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "id" : "1", "type" : "InternalServerError", "message" : "Un-handled Exception \n Please contact to administrator." } ] } } } } } } } } }, "/resellers/v7/invoices/" : { "get" : { "summary" : "Invoice Search", "tags" : [ "Invoices v7" ], "description" : "Search and retrieve invoices associated with your Ingram Micro reseller account using a range of filter parameters, including invoice number, customer purchase order number, order number, invoice date ranges, due date ranges, invoice status, invoice type, serial number, and special bid number.\n\nImportant — invoice type scope: Invoice Search v7 returns either Technology Solution (TS) invoices or Cloud Solution (CS) invoices within a single request, not both simultaneously. To retrieve invoices across both lines of business, two separate requests are required — one scoped to your TS account and one to your CS account using the appropriate IM-CustomerNumber for each.\n\nPagination: Results are returned in pages. Use pageNumber and pageSize to navigate large result sets. Always check the total record count in the response to determine whether additional pages exist.\n\nNext step: Use the invoiceNumber returned in search results with the Invoice Details v7 endpoint to retrieve the complete billing record for a specific invoice, including full line items, tax breakdown, freight charges, payment terms, and optionally serial numbers.", "operationId" : "get-resellers-invoices-v7", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-ApplicationID ", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222", "maxLength" : 10 } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "example" : "US", "maxLength" : 2, "minLength" : 2 } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "paymentTermsNetDate", "in" : "query", "description" : "Search by payment terms net date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "invoiceDate", "in" : "query", "description" : "Search by invoice date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "invoiceDueDate", "in" : "query", "description" : "Search by invoice date from(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "orderDate", "in" : "query", "description" : "Search by OrderDate date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "orderFromDate", "in" : "query", "description" : "Search by OrderFromDate date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "orderToDate", "in" : "query", "description" : "Search by OrderToDate date(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "orderNumber", "in" : "query", "description" : "Search by order number", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "DeliveryNumber", "in" : "query", "description" : "Search by delivery number.", "required" : false, "schema" : { "type" : "string", "example" : "335238411" } }, { "name" : "invoiceNumber", "in" : "query", "description" : "The Ingram Micro invoice number.", "required" : false, "schema" : { "type" : "string", "maxLength" : 11 } }, { "name" : "invoiceStatus", "in" : "query", "description" : "Ingram Micro invoice status.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "invoiceType", "in" : "query", "description" : "Ingram Micro InvoiceType.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "customerOrderNumber", "in" : "query", "description" : "Ingram Micro CustomerOrderNumber.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "endCustomerOrderNumber", "in" : "query", "description" : "Ingram Micro EndCustomerOrderNumber.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "specialBidNumber", "in" : "query", "description" : "Ingram Micro SpecialBidNumber.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "invoiceFromDueDate", "in" : "query", "description" : "Search by invoice due date from(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "invoiceToDueDate", "in" : "query", "description" : "Search by invoice due date to(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "example" : "2021-04-23" } }, { "name" : "invoiceFromDate", "in" : "query", "description" : "Search by invoice date from(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "items" : { "type" : "string", "example" : "2021-04-23" } } }, { "name" : "invoiceToDate", "in" : "query", "description" : "Search by invoice date To(yyyy-MM-dd).", "required" : false, "schema" : { "type" : "string", "items" : { "type" : "string", "example" : "2021-04-23" } } }, { "name" : "pageSize", "in" : "query", "description" : "Number of records required in the call - max records 100 per page.", "required" : false, "schema" : { "type" : "integer", "default" : "25", "format" : "int32" } }, { "name" : "pageNumber", "in" : "query", "description" : "The page number reference.", "required" : false, "schema" : { "type" : "integer", "default" : "1", "format" : "int32" } }, { "name" : "orderby", "in" : "query", "description" : "Column name with which we want to sort.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "InvoiceDate" } }, { "name" : "direction", "in" : "query", "description" : "asc or desc , along with orderby column result set will be sorted.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "desc" } }, { "name" : "serialNumber", "in" : "query", "description" : "Serial number of the product.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32 } } ], "responses" : { "200" : { "description" : "InvoiceSearchResponse to be returned", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceSearchResponse" }, "examples" : { "Success - 200" : { "value" : { "invoices" : [ { "paymentTermsDueDate" : "2022-11-10", "erpOrderNumber" : "40-MKTRW-11", "invoiceAmountInclTax" : 85.23, "invoiceNumber" : "40MKTRW11", "invoiceStatus" : "OPEN", "invoiceDate" : "2022-10-29", "invoiceDueDate" : "2022-11-10", "invoicedAmountDue" : 243.16, "customerOrderNumber" : "ZBJ3724", "endCustomerOrderNumber" : "NFP259", "orderCreateDate" : "2022-10-27" } ], "nextPage" : "/resellers/v6/invoices/?customerNumber=40-017165&invoiceFromDate=5/3/2022&invoiceToDate=10/30/2022&page=1&size=10&orderBy=invoiceDate&direction=desc&pageNumber=2", "recordsFound" : 89701, "pageSize" : 10, "pageNumber" : 1 } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "traceid" : "1", "type" : "errors/bad-request", "message" : "Input passed is not in right or expected format. Model Binding Error Happens at Global Model Binding Exception Handler.", "fields" : [ { "field" : "IM-CountryCode", "message" : "The countryCode field is required.", "value" : null } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "traceid" : "121", "type" : "System.Net.WebException", "message" : "Error while processing request for 1121,for SiteCode sg,for CorrelationId :121 , Message :The remote server returned an error: (404) Not Found.", "fields" : [ ] } ] } } } } } } } } }, "/resellers/v6/renewals/search" : { "post" : { "summary" : "Renewals Search", "tags" : [ "Renewals" ], "description" : "The Renewal Search API, by default, will retrieve all the renewals that are associated with the customer’s account. The customer will be able to search for renewals via basic search or advanced search. Basic search is available thru the query string parameters, whereas the advanced search is available thru the request body schema. ", "operationId" : "post-renewalssearch", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "Content type", "in" : "header", "description" : "The media type for JSON Request.", "required" : true, "schema" : { "type" : "string", "example" : "application/json" } }, { "name" : "customerOrderNumber", "in" : "query", "description" : "The reseller's unique PO/Order number.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ingramPurchaseOrderNumber", "in" : "query", "description" : "Sales order number.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "serialNumber", "in" : "query", "description" : "A serial number of the product.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "page", "in" : "query", "description" : "Number of page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "size", "in" : "query", "description" : "The submitted pagesize, default is 25.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sort", "in" : "query", "description" : "Refers to the column selected to apply the sorting criteria.", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/renewalsSearchRequest" }, "examples" : { "Sample" : { "value" : [ { "status" : { "OpporutinyStatus" : { "value" : "Closed", "subStatus" : "Renewal went direct" } }, "dateType" : { "startDate" : { "customStartDate" : "05/27/2023", "customEndDate" : "06/26/2023" }, "endDate" : { "customStartDate" : "06/26/2023", "customEndDate" : "07/26/2023" }, "invoiceDate" : { "customStartDate" : "05/27/2023", "customEndDate" : "06/26/2023" }, "expirationDate" : { "customStartDate" : "06/26/2023", "customEndDate" : "07/26/2023" } }, "vendor" : "HP", "endUser" : "STARK" } ] } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/renewalsSearchResponse" }, "examples" : { "SampleResponse" : { "value" : [ { "recordsFound" : 114, "pageSize" : 25, "pageNumber" : 1, "renewals" : [ { "renewalId" : 4239056, "customerOrderNumber" : "MyPONumber", "referenceNumber" : "", "endUser" : "ABC TECHNOLOGIES", "vendor" : "HP", "expirationDate" : "2023-07-04T00:00:00", "renewalValue" : 381.5, "status" : "Quote pending", "links" : [ { "topic" : "renewals", "href" : "/resellers/v6/renewals/4419005", "type" : "Get" }, { "topic" : "quotedetails", "href" : "/resellers/v6/quotes/QUO-15850886-M6H4V9", "type" : "Get" } ] } ], "nextPage" : "/resellers/v6/renewals/search?page=2" } ] } } } } }, "400" : { "description" : "Error: Bad Request", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "type" : "string", "description" : "Unique Id to identify error." }, "type" : { "type" : "string", "description" : "Describes the type of the error." }, "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 field message." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." } } } } } }, "examples" : { "SampleResponse" : { "value" : [ { "errors" : [ { "traceid" : "fbac82ba-cf0a-4bcf-fc03-0c5084", "type" : "/errors/validation-failed", "fields" : [ { "field" : "IM-CustomerNumber", "message" : "Invalid CustomerNumber", "value" : "20222222" }, { "field" : "IM-CountryCode", "message" : "Invalid CountryCode", "value" : "USA" } ] } ] } ] } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "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" } } } }, "examples" : { "SampleResponse" : { "value" : [ { "errors" : [ { "traceid" : "123", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred. Please contact Ingram Micro API support team", "fields" : [ ] } ] } ] } } } } } } } }, "/resellers/v6/renewals/{renewalId}" : { "get" : { "summary" : "Renewals Details", "tags" : [ "Renewals" ], "description" : "The Renewal Details API endpoint will retrieve all the details related to the renewal. The customer is required to pass renewalId as a path parameter while sending a request.", "operationId" : "get-resellers-v6-renewalsdetails", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222", "maxLength" : 10 } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "example" : "US", "maxLength" : 2, "minLength" : 2 } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "renewalId", "in" : "path", "description" : "Unique Ingram renewal ID.", "required" : true, "schema" : { "type" : "string", "example" : "123456" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/renewalsDetailsResponse" }, "examples" : { "Success - 200" : { "value" : { "renewalId" : "1234567", "ingramOrderNumber" : "", "ingramOrderDate" : null, "expirationDate" : "2023-07-20T00:00:00", "ingramPurchaseOrderNumber" : "", "customerOrderNumber" : "80000", "endCustomerOrderNumber" : "115030.0", "renewalValue" : "5594", "endUser" : "ABC", "vendor" : "VMWARE", "status" : "Quote closed contact sales desk", "endUserInfo" : { "contact" : "Thanos ", "companyName" : "ABC Technologies", "addressLine1" : "182 Pine Ave", "addressLine2" : "", "city" : "Buffalo", "state" : "NY", "postalCode" : "13206", "countryCode" : "", "phoneNumber" : "(206)123-4567", "email" : "user@ingrammicro.com" }, "referenceNumber" : { "notificationId" : "", "quoteNumber" : "" }, "products" : [ { "ingramLineNumber" : "1", "productDescription" : "", "vendorPartNumber" : "21556581", "ingramPartNumber" : "08NM78", "manufacturerPartNumber" : "", "unitPrice" : 5594, "quantity" : 4, "isConsolidated" : "No" }, { "ingramLineNumber" : "2", "productDescription" : "", "vendorPartNumber" : "22322080", "ingramPartNumber" : "08NM78", "manufacturerPartNumber" : "", "unitPrice" : 5594, "quantity" : 6, "isConsolidated" : "Yes" } ], "additionalAttributes" : [ { "attributeDescription" : "LicenseCertificate", "attributeValue" : "3729027", "startDate" : null, "expirationDate" : null, "isConsolidated" : "" }, { "attributeDescription" : "SerialNumber", "attributeValue" : "9517647541", "startDate" : null, "expirationDate" : null, "isConsolidated" : "" } ] } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "type" : "string", "description" : "Unique Id to identify error." }, "type" : { "type" : "string", "description" : "Describes the type of the error." }, "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 field message." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." } } } } } }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "traceid" : "Test", "type" : "/errors/validation-failed", "message" : null, "fields" : [ { "field" : "IM-CustomerNumber", "message" : "Invalid CustomerNumber", "value" : "20222222" }, { "field" : "IM-CountryCode", "message" : "Invalid CountryCode", "value" : "USA" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "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" } } } }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "traceid" : "123", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred. Please contact Ingram Micro API support team", "fields" : [ ] } ] } } } } } } } } }, "/resellers/v6/deals/search" : { "get" : { "summary" : "Deals Search", "tags" : [ "Deals" ], "description" : "The Deals Search API, by default, will retrieve all the deals that are associated with the customer’s account. The customer will be able to search deals using the End-user name, Vendor name, or DealID. ", "operationId" : "get-resellers-v6-dealssearch", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222", "maxLength" : 10 } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "example" : "US", "maxLength" : 2, "minLength" : 2 } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "endUser", "in" : "query", "description" : "The end user/customer's name.", "required" : false, "schema" : { "type" : "string", "example" : "EnduserCompany" } }, { "name" : "vendor", "in" : "query", "description" : "The vendor's name.", "required" : false, "schema" : { "type" : "string", "example" : "Cisco" } }, { "name" : "dealId", "in" : "query", "description" : "Deal/Special bid number.", "required" : false, "schema" : { "type" : "string", "example" : "12345678" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/dealsSearchResponse" }, "examples" : { "Success - 200" : { "value" : { "recordsFound" : 2301, "pageSize" : 2, "pageNumber" : 1, "deals" : [ { "dealId" : "TEST-RESEU DISC", "version" : "1", "endUser" : "AB & C DEALS", "vendor" : "TESTVENDOR", "dealExpiryDate" : "2023-07-31T00:00:00", "links" : { "topic" : "Deals", "href" : "/resellers/v6/deals/TEST-RESEU DISC", "type" : "GET" } }, { "dealId" : "TEST-RESEU DISC2", "version" : "1", "endUser" : "AB & C DEALS", "vendor" : "TESTVENDOR", "dealExpiryDate" : "2023-07-31T00:00:00", "links" : { "topic" : "Deals", "href" : "/resellers/v6/deals/TEST-RESEU DISC2", "type" : "GET" } } ], "nextPage" : "/bids/v1/special-bidsB2B?Size=25&Page=2", "previousPage" : null } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "type" : "string", "description" : "Unique Id to identify error." }, "type" : { "type" : "string", "description" : "Describes the type of the error." }, "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 field message." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." } } } } } }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "traceid" : "Test", "type" : "/errors/validation-failed", "message" : null, "fields" : [ { "field" : "IM-CustomerNumber", "message" : "Invalid CustomerNumber", "value" : "20222222" }, { "field" : "IM-CountryCode", "message" : "Invalid CountryCode", "value" : "USA" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "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" } } } }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "traceid" : "123", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred. Please contact Ingram Micro API support team", "fields" : [ ] } ] } } } } } } } } }, "/resellers/v6/deals/{dealId}" : { "get" : { "summary" : "Deals Details", "tags" : [ "Deals" ], "description" : "The Deals Details API will retrieve all the details related to the specific deal id.", "operationId" : "get-resellers-v6-dealsdetails", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222", "maxLength" : 10 } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "example" : "US", "maxLength" : 2, "minLength" : 2 } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "dealId", "in" : "path", "description" : "Unique deal ID.", "required" : true, "schema" : { "type" : "string", "example" : "12345678" } },{ "name": "vendorName", "in" : "query", "description": "Vendor for that bid", "required" : true, "schema" : { "type" : "string", "example" : "Cisco" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/dealsDetailsResponse" }, "examples" : { "Success - 200" : { "value" : { "dealId" : "23456789", "version" : "6", "endUser" : "1ST MACHINE USA INC", "extendedMsrp" : 15944.61, "vendor" : null, "dealReceivedOn" : "2023-06-15T02:30:00", "dealExpiryDate" : "2023-07-11T00:00:00", "priceProtectionEndDate" : "2023-07-11T13:18:30", "currencyCode" : "USD", "endUserInfo" : { "contact" : "Stark", "companyName" : null, "addressLine1" : "567 BACK ST", "addressLine2" : "4", "city" : "BROOKLYN", "state" : "NY", "postalCode" : "11801", "countryCode" : "US", "phoneNumber" : null, "email" : "stark@newcomp.com" }, "products" : [ { "ingramPartNumber" : "US1860", "vendorPartNumber" : "NEW-MX100-SEE-2YR", "upc" : null, "productDescription" : "CISCO MERAKI 1YR MX100 ADVANCED", "msrp" : 4906.11, "extendedMSRP" : 4906.11, "approvedQuantity" : 1, "remainingQuantity" : 1, "comments" : null, "specialConditions" : null, "startDate" : "2023-01-11T00:00:00", "expirationDate" : "2023-07-11T00:00:00", "daysRemaining" : 181 } ] } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "type" : "string", "description" : "Unique Id to identify error." }, "type" : { "type" : "string", "description" : "Describes the type of the error." }, "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 field message." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." } } } } } }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "traceid" : "Test", "type" : "/errors/validation-failed", "message" : null, "fields" : [ { "field" : "IM-CustomerNumber", "message" : "Invalid CustomerNumber", "value" : "20222222" }, { "field" : "IM-CountryCode", "message" : "Invalid CountryCode", "value" : "USA" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "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" } } } }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "traceid" : "123", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred. Please contact Ingram Micro API support team", "fields" : [ ] } ] } } } } } } } } }, "/resellers/v6/returns/search" : { "get" : { "summary" : "Returns Search", "tags" : [ "Returns" ], "description" : "The Returns Search API, by default, will retrieve all the returns that are associated with the customer’s account. The customer will be able to search returns using the query parameters. The Returns Search response will return the following information: returnClaimId, caseRequestNumber, createdOn, referenceNumber, and returnReason.", "operationId" : "get-resellers-v6-returnssearch", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222", "maxLength" : 10 } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "example" : "US", "maxLength" : 2, "minLength" : 2 } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "caseRequestNumber", "in" : "query", "description" : "A unique return request number.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "invoiceNumber", "in" : "query", "description" : "The Invoice number for the order.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "returnClaimId", "in" : "query", "description" : "A unique return claim Id.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "referenceNumber", "in" : "query", "description" : "The reference number for the return.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ingramPartNumber", "in" : "query", "description" : "Unique IngramMicro part number.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "vendorPartNumber", "in" : "query", "description" : "The vendor's part number.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "returnStatus-in", "in" : "query", "description" : "Comma-separated values of pre-defined status. Open, Approved, Partially Approved, Denied, Voided.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "claimStatus-in", "in" : "query", "description" : "Comma-separated values of pre-defined status. Open, Approved, Partially Approved, Denied, Voided.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "createdOn-bt", "in" : "query", "description" : "The date on which the return request was created. ", "required" : false, "schema" : { "type" : "string" } }, { "name" : "modifiedOn-bt", "in" : "query", "description" : "The date on which the return request was last updated.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "returnReason-in", "in" : "query", "description" : "Comma separated Pre-defined value. test, (EW) Express Warehousing, (AR) Account Receivables, (BB) Buy Back, (BE) Stock Balance Exception, (BO) Bill Only, (CE) Credit Dept Use - Credit Exception, (CF) Configuration Fee, (CS ) Customer Service Discretion, (CS1) Customer Service Discretion CS Error, (DE) Defective Exception, (DF) Defective Items, (DI) Direct Credit, (DM) Damaged from Carrier, (DN) Damaged Without Product, (DT) Direct/ Special Order, (DT1) Direct Ship billed, not shipped., (FO) Freight Out, (FX) No-Scan, (IN) Incomplete, (LS) Lost Shipment, (MN) Minimum Order Fee Credit, (OS) Over Shipment, (PR) Pricing Error, (RF) Refusal Credit, (RI) Re-Invoice, (RP) Return For Repair, (RT) Return Not Credited, (RTD) RCN, (SB) Stock Balance, (SD) Sales Discretion, (SH) Incorrect Shipping And Handling, (SS) Short Shipment, (SSK) Short Ship kit, (SW) Sales Writeoff, (TE) Opened Return, (TR) Training Refund, (TX) Tax Credit, (WS) Wrong Sales Sealed, (WW) Wrong Warehouse, (FS) Warehouse Failed Serial# Capture, Latin America Vendor Credits, Select Source, ITAD - Trade-in Credit, Withholding Tax", "required" : false, "schema" : { "type" : "string" } }, { "name" : "page", "in" : "query", "description" : "Number of page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "size", "in" : "query", "description" : "The submitted pagesize, default is 25", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sort", "in" : "query", "description" : "Refers to the column selected to apply the sorting criteria.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sortingColumnName", "in" : "query", "description" : "The column name which will be sorted on.", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/returnsSearchResponse" }, "examples" : { "Success - 200" : { "value" : { "recordsFound": 1, "pageSize": 25, "pageNumber": 1, "returnsClaims": [ { "returnClaimId": "", "caseRequestNumber": "CAS-12345-G0S5J1-1", "createdOn": "2023-04-13T04:08:35-07:00", "type": "Claim", "returnReason": "", "referenceNumber": "RNGGG11CS/PN", "estimatedTotalValue": 2324, "credit": 2324.0, "modifiedOn": "2023-07-18T04:16:16-07:00", "status": "OPEN", "links": [ { "topic": "returnsClaimsDetails", "href": "/resellers/v6/returns/CAS-12345-G0S5J1-1", "type": "get" } ] } ], "nextPage": null, "previousPage": null } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "type" : "string", "description" : "Unique Id to identify error." }, "type" : { "type" : "string", "description" : "Describes the type of the error." }, "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 field message." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." } } } } } }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "traceid" : "Test", "type" : "/errors/validation-failed", "message" : null, "fields" : [ { "field" : "IM-CustomerNumber", "message" : "Invalid CustomerNumber", "value" : "20222222" }, { "field" : "IM-CountryCode", "message" : "Invalid CountryCode", "value" : "USA" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "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" } } } }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "traceid" : "123", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred. Please contact Ingram Micro API support team", "fields" : [ ] } ] } } } } } } } } }, "/resellers/v6/returns/{caseRequestNumber}" : { "get" : { "summary" : "Returns Details", "tags" : [ "Returns" ], "description" : "The Returns Details API will retrieve all the details related to the specific caseRequestNumber.", "operationId" : "get-resellers-v6-returnsdetails", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "example" : "20-222222", "maxLength" : 10 } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "example" : "US", "maxLength" : 2, "minLength" : 2 } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } }, { "name" : "caseRequestNumber", "in" : "path", "description" : "A unique return request number.", "required" : true, "schema" : { "type" : "string", "example" : "12345678" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/returnsDetailsResponse" }, "examples" : { "Success - 200" : { "value" : { "typeOfDetails": "Claim", "rmaClaimId": "12-RH5LX-34", "caseRequestNumber": "CAS-12345-M4H2Y8-0", "createdOn": "2022-02-02T19:33:10Z", "returnReason": "(CS ) Customer Service Discretion", "referenceNumber": "RH4QP21CS/PN49", "status": "Open", "returnWarehouseAddress": "Ingram Micro Returns (ref RMA#)\n82 Micro Drive\nJonestown, PA 17038\n", "products": [ { "ingramLineNumber": 1, "description": "PRO 3YR TOTAL COMPLETE FOR DOWN\nBUSINESS ADP", "ingramPartNumber": "RX1000", "vendorPartNumber": "A9W-12345", "upc": null, "invoiceDate": "2022-01-24T00:00:00Z", "invoiceNumber": "20-RH123-21", "customerOrderNumber": "CONCURR021", "quantity": 1.0, "unitPrice": 213.75, "extendedPrice": 213.750, "status": "Open", "returnBranch": "96", "shipFromBranch": "49", "requestDetails": null, "additionalDetails": null } ], "subTotal": 213.75, "tax": 0.0, "additionalFees": 0, "estimatedTotal": 213.75 } } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "type" : "string", "description" : "Unique Id to identify error." }, "type" : { "type" : "string", "description" : "Describes the type of the error." }, "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 field message." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." } } } } } }, "examples" : { "400 - Bad Request" : { "value" : { "errors" : [ { "traceid" : "Test", "type" : "/errors/validation-failed", "message" : null, "fields" : [ { "field" : "IM-CustomerNumber", "message" : "Invalid CustomerNumber", "value" : "20222222" }, { "field" : "IM-CountryCode", "message" : "Invalid CountryCode", "value" : "USA" } ] } ] } } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "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" } } } }, "examples" : { "Server Error" : { "value" : { "errors" : [ { "traceid" : "123", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred. Please contact Ingram Micro API support team", "fields" : [ ] } ] } } } } } } } } }, "/resellers/v6/returns/create" : { "post" : { "summary" : "Returns Create", "tags" : [ "Returns" ], "description" : "Return create endpoint will allow customers to create a return request. In order to create a request, the customer must provide either ingramPartNumber or vendorPartNumber along with other required fields listed below. ", "operationId" : "post-returnscreate", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } },{ "name" : "IM-CustomerContact", "in" : "header", "description" : "Logged in Users email address contact.", "required" : true, "schema" : { "type" : "string", "maxLength" : 64, "example" : "MyCompany" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction. Example: MyCompany", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/returnsCreateRequest" }, "examples" : { "Sample" : { "value" : { "list" : [ { "invoiceNumber" : "40-NFERG-11", "invoiceDate" : "2023-07-18", "customerOrderNumber" : "", "ingramPartNumber" : "164B2G", "vendorPartNumber" : "", "serialNumber" : "", "quantity" : "1", "primaryReason" : "I have not received part or all of my order", "secondaryReason" : "Received only partial shipment.", "notes" : "B2BCartCreation20", "referenceNumber" : "RefNum", "billToAddressId" : "000", "shipFromInfo" : { "companyName" : "ABC TECH", "contact" : "STARK", "addressLine1" : "17501 W 98TH ST SPC 1833", "addressLine2" : "string", "city" : "LENEXA", "state" : "KS", "postalCode" : "662191736", "countryCode" : "US", "email" : "stark@gmail.com", "phoneNumber" : "" }, "numberOfBoxes" : "1" } ] } } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/returnsCreateResponse" }, "examples" : { "SampleResponse" : { "value" : { "returnsClaims": [ { "rmaClaimId": "", "caseRequestNumber": "CAS-08946-G1W3J3-1", "referenceNumber": "B2BTest-US", "createdOn": "2023-07-31T07:00:00Z", "type": "CLAIM", "returnReason": "(SS) Short Shipment", "ingramPartNumber": "YZ3606", "vendorPartNumber": "", "quantity": 1, "notes": "B2B RMA TEST-US", "estimatedTotalValue": 4165, "credit": null, "status": "Open", "links": [ { "topic": "returnsClaimsDetails", "href": "/resellers/v6/returns/CAS-08946-G1W3J3-1", "type": "get" } ] } ] } } } } } }, "400" : { "description" : "Error: Bad Request", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "type" : "string", "description" : "Unique Id to identify error." }, "type" : { "type" : "string", "description" : "Describes the type of the error." }, "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 field message." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." } } } } } }, "examples" : { "SampleResponse" : { "value" : [ { "errors" : [ { "traceid" : "fbac82ba-cf0a-4bcf-fc03-0c5084", "type" : "/errors/validation-failed", "fields" : [ { "field" : "IM-CustomerNumber", "message" : "Invalid CustomerNumber", "value" : "20222222" }, { "field" : "IM-CountryCode", "message" : "Invalid CountryCode", "value" : "USA" } ] } ] } ] } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "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" } } } }, "examples" : { "SampleResponse" : { "value" : [ { "errors" : [ { "traceid" : "123", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred. Please contact Ingram Micro API support team", "fields" : [ ] } ] } ] } } } } } } } }, "/resellers/v6/freightestimate" : { "post" : { "summary" : "Freight Estimate", "tags" : [ "Freight Estimate" ], "description" : "The freight estimator endpoint will allow customers to understand the freight cost for an order.", "operationId" : "post-freightestimate", "security" : [{ "application" : [ "read" ] }], "parameters" : [ { "name" : "IM-CustomerNumber", "in" : "header", "description" : "Your unique Ingram Micro customer number.", "required" : true, "schema" : { "type" : "string", "maxLength" : 10, "example" : "20-222222" } }, { "name" : "IM-CountryCode", "in" : "header", "description" : "Two-character ISO country code.", "required" : true, "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "example" : "US" } }, { "name" : "IM-CorrelationID", "in" : "header", "description" : "Unique transaction number to identify each transaction across all the systems.", "required" : true, "schema" : { "type" : "string", "maxLength" : 32, "example" : "fbac82ba-cf0a-4bcf-fc03-0c5084" } }, { "name" : "IM-CustomerContact", "in" : "header", "description" : "Logged in Users email address contact.", "required" : true, "schema" : { "type" : "string", "maxLength" : 64, "example" : "John.Doe@reseller.com" } }, { "name" : "IM-SenderID", "in" : "header", "description" : "Unique value used to identify the sender of the transaction.", "required" : false, "schema" : { "type" : "string", "maxLength" : 32, "example" : "MyCompany" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/freightRequest" }, "examples" : { "Sample" : { "value" : { "billToAddressId": "000", "shipToAddressId": "200", "shipToAddress":{ "companyName":"ABC TECH", "addressLine1":"17501 W 98TH ST SPC 1833", "addressLine2":"string", "city":"LENEXA", "state":"KS", "postalCode":"662191736", "countryCode":"US" }, "lines": [ { "customerLineNumber": "001", "ingramPartNumber": "A300-123456", "quantity": "1", "warehouseId": "20", "carrierCode": "" }, { "customerLineNumber": "002", "ingramPartNumber": "A300-789012", "quantity": "1", "warehouseId": "10", "carrierCode": "" } ] } } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/freightResponse" }, "examples" : { "SampleResponse" : { "value" : { "freightEstimateResponse": { "currencyCode": "USD", "totalFreightAmount": 58.64, "totalTaxAmount": 0.00, "totalFees": 0.00, "totalNetAmount": 0.00, "grossAmount": 418.17, "distribution": [ { "shipFromBranchNumber": "10", "carrierCode": "RG", "shipVia": "FEDEX GROUND", "freightRate": 19.700, "totalWeight": 13.000, "transitDays": 1, "carrierList": [ { "carrierCode": "RG", "shipVia": "FEDEX GROUND", "carrierMode": "SML", "estimatedFreightCharge": "19.7", "daysInTransit": "1" }, { "carrierCode": "UG", "shipVia": "UPS GROUND ", "carrierMode": "SML", "estimatedFreightCharge": "23.8", "daysInTransit": "1" } ] }, { "shipFromBranchNumber": "20", "carrierCode": "RG", "shipVia": "FEDEX GROUND", "freightRate": 38.940, "totalWeight": 13.000, "transitDays": 3, "carrierList": [ { "carrierCode": "RG", "shipVia": "FEDEX GROUND", "carrierMode": "SML", "estimatedFreightCharge": "38.94", "daysInTransit": "3" }, { "carrierCode": "HD", "shipVia": "FDX HOME DEL", "carrierMode": "SML", "estimatedFreightCharge": "46", "daysInTransit": "3" } ] } ], "lines": [ { "ingramPartNumber": "A300-123456", "vendorPartNumber": "123456", "warehouseId": "20", "quantity": 1.00, "unitPrice": 198.07, "netAmount": 198.07 }, { "ingramPartNumber": "A300-789012", "vendorPartNumber": "789012", "warehouseId": "10", "quantity": 1.00, "unitPrice": 161.46, "netAmount": 161.46 } ] } } } } } } }, "400" : { "description" : "Error: Bad Request", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "type" : "string", "description" : "Unique Id to identify error." }, "type" : { "type" : "string", "description" : "Describes the type of the error." }, "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 field message." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." } } } } } }, "examples" : { "SampleResponse" : { "value" : [ { "errors" : [ { "traceid" : "fbac82ba-cf0a-4bcf-fc03-0c5084", "type" : "/errors/validation-failed", "fields" : [ { "field" : "IM-CustomerNumber", "message" : "Invalid CustomerNumber", "value" : "20222222" }, { "field" : "IM-CountryCode", "message" : "Invalid CountryCode", "value" : "USA" } ] } ] } ] } } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "traceid" : { "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" } } } }, "examples" : { "SampleResponse" : { "value" : [ { "errors" : [ { "traceid" : "123", "type" : "/errors/system-errors", "message" : "Some unexpected error occurred. Please contact Ingram Micro API support team", "fields" : [ ] } ] } ] } } } } } } } }, "/resellers/v5/invoices/{invoiceNumber}" : { "get" : { "summary" : "Get Invoice Details", "operationId" : "get-invoices", "description" : "View invoice details. This is a request to query invoice details for a specific Ingram Micro order placed in the last 9 months, whether open or shipped.\n\n invoiceNumber, isoCountryCode and customerNumber parameters are required.", "security" : [ { "application" : [ "read" ] } ], "tags" : [ "Invoices V5" ], "parameters" : [ { "schema" : { "type" : "string", "maxLength" : 10, "default" : "20-222222" }, "in" : "query", "name" : "customerNumber", "description" : "Your unique Ingram Micro customer number", "required" : true }, { "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "default" : "US" }, "in" : "query", "name" : "isoCountryCode", "description" : "ISO 2 char country code", "required" : true } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/invoiceDetails" }, "examples" : { "Example" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS", "statuscode" : "200", "responsemessage" : "Invoice Found" }, "invoicedetailresponse" : { "invoicenumber" : "RCW67-11", "customerordernumber" : "ZFEDRGT", "customerfreightamount" : "0.00", "customerforeignfrightamt" : "0.00", "totaltaxamount" : "0", "totalamount" : "61.22", "shiptosuffix" : "200", "billtosuffix" : "000", "billto" : { "name1" : "INGRAM MICRO CAPS TEST ACCOUNT", "addressline1" : "1759 WEHRLE DR", "city" : "WILLIAMSVILLE", "state" : "NY", "postalcode" : "142217033", "countrycode" : "US" }, "paymentterms" : "200", "orderdate" : "2020-01-06", "carrier" : "OT", "carrierdescription" : "OTHER", "discountamount" : "0.00", "enduserponumber" : null, "freightforwardercode" : null, "creditmemoreasoncode" : null, "holdreason" : null, "shipcomplete" : null, "shipdate" : "2020-01-06", "companycurrency" : "USD", "currencycode" : "USD", "currencyrate" : "1.000000", "globalorderid" : "20-RCW67-11", "originalshipcode" : null, "orderstatus" : "I", "shiptoaddress" : { "name1" : "INGRAM MICRO TEST ACCOUNT", "addressline1" : "ATTN TOD DEBIE", "addressline2" : "1610 E SAINT ANDREW PL", "city" : "SANTA ANA", "state" : "CA", "postalcode" : "927054931", "countrycode" : "US" }, "totalsales" : "61.22", "weight" : "5.00", "lines" : [ { "linenumber" : "1", "partnumber" : "123511", "vendorpartnumber" : "F2A032-06", "partdescription" : "666 PARALLEL PRINTER DB25M TO CABLCENT36M PRO SERIES 28AWG ROHS", "shipfrombranch" : "10", "shippedquantity" : "1", "orderedquantity" : "1", "backorderquantity" : "0", "extendedprice" : "30.61", "specialbidnumber" : null, "ordersuffix" : "11", "unitprice" : "30.61", "unitofmeasure" : "EA", "productextendedspecs" : [ { "attributename" : "commenttext", "attributevalue" : "EU#-001599983 ASPECT AUTOMATION LLMC#C" } ] }, { "linenumber" : "2", "partnumber" : "123511", "vendorpartnumber" : "F2A032-06", "partdescription" : "666 PARALLEL PRINTER DB25M TO CABLCENT36M PRO SERIES 28AWG ROHS", "shipfrombranch" : "10", "shippedquantity" : "1", "orderedquantity" : "1", "backorderquantity" : "0", "extendedprice" : "30.61", "specialbidnumber" : null, "ordersuffix" : "11", "unitprice" : "30.61", "unitofmeasure" : "EA", "productextendedspecs" : [ { "attributename" : "commenttext", "attributevalue" : "EU#-001599983 ASPECT AUTOMATION LLMC#C" } ] }, { "linenumber" : "3", "partnumber" : "123511", "vendorpartnumber" : "F2A032-06", "partdescription" : "666 PARALLEL PRINTER DB25M TO CABLCENT36M PRO SERIES 28AWG ROHS", "shipfrombranch" : "10", "shippedquantity" : "0", "orderedquantity" : "1", "backorderquantity" : "1", "extendedprice" : "0.00", "specialbidnumber" : null, "ordersuffix" : "11", "unitprice" : "30.61", "unitofmeasure" : "EA" }, { "linenumber" : "895", "vendorpartnumber" : null, "partdescription" : "FREE FREIGHT", "shipfrombranch" : "10", "shippedquantity" : "0", "orderedquantity" : "0", "backorderquantity" : "0", "extendedprice" : "0.00", "specialbidnumber" : null, "ordersuffix" : "11", "unitprice" : "0", "unitofmeasure" : null } ] } } } } } } } } } }, "parameters" : [ { "schema" : { "type" : "string", "maxLength" : 12, "default" : "20-RCW67-11" }, "name" : "invoiceNumber", "in" : "path", "description" : "Ingram Micro Invoice Number", "required" : true } ] }, "/resellers/v5/Orders" : { "post" : { "summary" : "Create a New Order", "operationId" : "post-v5-orders-create", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderCreateResponse" }, "examples" : { "Example" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS", "statuscode" : "WY", "responsemessage" : "Note: (WY) Address fixed by group 1" }, "ordersummary" : { "customerponumber" : "CUSTUMERPO-1", "totalorderamount" : 6.77, "totalordercreated" : "1", "shiptoaddress" : { "attention" : "INGRAM MICRO", "addressline1" : "3351 MICHELSON DR", "city" : "IRVINE", "state" : "CA", "postalcode" : "926120696", "countrycode" : "US" }, "ordercreateresponse" : [ { "numberoflineswithsuccess" : "1", "numberoflineswitherror" : "0", "numberoflineswithwarning" : "0", "globalorderid" : "20-RD12J", "ordertype" : "S", "ordertimestamp" : "2020-04-04", "invoicingsystemorderid" : "20-RD12J", "taxamount" : 0, "freightamount" : 0, "orderamount" : 6.77, "lines" : [ { "linetype" : "P", "globallinenumber" : "002", "partnumber" : "TSXML3", "linenumber" : "4", "carriercode" : "OT", "carrierdescription" : "OTHER", "requestedunitprice" : 6.77, "requestedquantity" : 1, "confirmedquantity" : 1, "backorderedquantity" : 0, "unitproductprice" : 6.77, "netamount" : 6.77, "warehouseid" : "10", "ordersuffix" : "11" } ] } ] } } } } } } } } }, "security" : [ { "application" : [ "write" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderCreateRequest" }, "examples" : { "With Ingram Part No." : { "value" : { "ordercreaterequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "ordercreatedetails" : { "customerponumber" : "CustumerPO-1", "shiptoaddress" : { "attention" : "John Smith", "addressline1" : "Ingram Micro", "addressline2" : "3351 Michelson Dr", "city" : "Long Beach", "state" : "CA", "postalcode" : "92612", "countrycode" : "US" }, "carriercode" : "OT", "lines" : [ { "linetype" : "P", "linenumber" : "002", "quantity" : "1", "ingrampartnumber" : "TSXML3" } ], "extendedspecs" : [ { "attributename" : "isdirectshiporder", "attributevalue" : "false" }, { "attributename" : "euponumber", "attributevalue" : "1234" }, { "attributename" : "commenttext", "attributevalue" : "Happy Birthday Mom" }, { "attributename" : "duplicatecustomerordernumbervalidate", "attributevalue" : "ALLOW" }, { "attributename" : "commenttext", "attributevalue" : "///This order must ship on FedEx" }, { "attributename" : "commenttext", "attributevalue" : "/// 3rd account# 12345678" } ] } } } }, "With Vendor Part No." : { "value" : { "ordercreaterequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "ordercreatedetails" : { "customerponumber" : "CustumerPO-1", "carriercode" : "OT", "lines" : [ { "linetype" : "P", "linenumber" : "002", "quantity" : "1", "vendorpartnumber" : "PA03670-B055" } ], "extendedspecs" : [ { "attributename" : "commenttext", "attributevalue" : "This is a test comment text" } ] } } } } } } } }, "tags" : [ "Orders v5" ], "description" : "Instantly create and place orders. The POST API supports stocked SKUs as well as licensing and warranties SKUs.\n\n Every order to be created with this API must complete these validations to be placed and processed:\n\n Ingram Micro recommends that you provide the ingrampartnumber for each SKU contained in each order.\n\n When using vendorpartnumber to place an order, please use the product search endpoint to find the ingrampartnumber for a specific vendorpartnumber, and then supply the ingrampartnumber to place an order.\n\n NOTE: You must have net terms to use the Ingram Micro Order Create API. Ingram Micro offers trade credit when using our APIs, and repayment is based on net terms. For example, if your net terms agreement is net-30, you will have 30 days to make a full payment. Ingram Micro does not allow credit card transactions for API ordering." } }, "/resellers/v5/Orders/search" : { "get" : { "summary" : "Search your Orders", "operationId" : "get-orders-search", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderSearchResponse" }, "examples" : { "Success Example" : { "value" : { "serviceresponse" : { "responsepreamble" : { "requeststatus" : "SUCCESS", "returnmessage" : "Data found" }, "ordesearchresponse" : { "ordersfound" : "1", "pagesize" : "1", "pagenumber" : "1", "orders" : [ { "ordernumber" : "20-RD128", "entrytimestamp" : "2020-04-03T15:54:39Z", "customerordernumber" : "ZENPO", "suborders" : [ { "subordernumber" : "20-RD128-11", "statuscode" : "C", "status" : "CREDIT HOLD", "holdreasoncode" : "CH", "holdreason" : "HARD-9 CUST NOT FLOOR ORD", "links" : [ { "topic" : "orders", "href" : "/resellers/v5/orders/20-RD128-11?customerNumber=20-222222&isoCountryCode=US", "type" : "GET" }, { "topic" : "invoices", "href" : "/resellers/v5/invoices/20-RD128-11?customerNumber=20-222222&isoCountryCode=US", "type" : "GET" } ] } ], "links" : { "topic" : "orders", "href" : "/resellers/v5/orders/20-RD128?customerNumber=20-222222&isoCountryCode=US", "type" : "GET" } } ] } } } }, "Data not found" : { "value" : { "serviceresponse" : { "responsepreamble" : { "requeststatus" : "FAILED", "returnmessage" : "No data found" }, "ordesearchresponse" : { "ordersfound" : "0", "pagesize" : "0", "pagenumber" : "1" } } } } } } } } }, "description" : "Search your Ingram Micro orders. This endpoint searches by multiple order parameters and supports pagination of results. Search using one or more of the parameters below:\n\n \n\n For pagination, please use these parameters:\n \n\n Order Status Values:\n \n\n The search endpoint also returns HATEOAS links for order details and invoice details, if applicable.", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "schema" : { "type" : "string", "example" : "20-222222" }, "in" : "query", "name" : "customerNumber", "description" : "Your unique Ingram Micro customer number", "required" : true }, { "schema" : { "type" : "string", "minLength" : 2, "maxLength" : 2, "example" : "US" }, "in" : "query", "name" : "isocountrycode", "description" : "2 char iso country code", "required" : true }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "ordernumber", "description" : "Ingram sales order number" }, { "schema" : { "type" : "string", "example" : "ZENPO1" }, "in" : "query", "name" : "customerordernumber", "description" : "Search using your PO/Order number" }, { "schema" : { "type" : "string", "default" : "any", "enum" : [ "P", "R", "4", "I", "V" ], "example" : "", "minLength" : 1, "uniqueItems" : false }, "in" : "query", "name" : "orderstatus", "description" : "Ingram Micro order status" }, { "schema" : { "type" : "string", "format" : "date-time" }, "in" : "query", "name" : "startcreatetimestamp", "description" : "Search start date/time in UTC format", "explode" : false, "allowEmptyValue" : false, "allowReserved" : false }, { "schema" : { "type" : "string", "format" : "date-time" }, "in" : "query", "name" : "endcreatetimestamp", "description" : "Search end date/time in UTC format" }, { "schema" : { "type" : "integer", "default" : "25" }, "in" : "query", "name" : "pagesize", "description" : "Number of records required in the call" }, { "schema" : { "type" : "integer", "default" : 1 }, "in" : "query", "name" : "pagenumber", "description" : "the page number reference" } ], "tags" : [ "Orders v5" ] } }, "/resellers/v5/Orders/{ordernumber}" : { "get" : { "summary" : "Get Order Details", "tags" : [ "Orders v5" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderDetailResponse" }, "examples" : { "Success" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "orderdetailresponse" : { "ordernumber" : "20-RD128", "ordertype" : "D", "customerordernumber" : "ZENPO", "orderstatus" : "CREDIT HOLD", "entrytimestamp" : "2020-04-03T08:54:39-07:00", "entrymethoddescription" : "VIA LU62", "ordertotalvalue" : 14.67, "ordersubtotal" : 6.67, "freightamount" : 8, "currencycode" : "USD", "totalweight" : "1", "totaltax" : "0", "billtoaddress" : { "suffix" : "000", "name" : "INGRAM MICRO CAPS TEST ACCOUNT", "addressline1" : "1759 WEHRLE DR", "city" : "WILLIAMSVILLE", "state" : "NY", "postalcode" : "142217033", "countrycode" : "US" }, "shiptoaddress" : null, "enduserinfo" : null, "lines" : [ { "linenumber" : "004", "globallinenumber" : "002", "ordersuffix" : "11", "erpordernumber" : "20-RD128-11", "linestatus" : "CREDIT HOLD", "partnumber" : "TSXML2", "manufacturerpartnumber" : "TESTXMLSKU2", "vendorname" : "TEST VENDOR NUMBER 6", "vendorcode" : "TST6", "partdescription1" : "CLASS X SKU NO STOCK", "unitweight" : "1", "unitprice" : 6.67, "extendedprice" : 6.67, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "shipmentdetails" : [ { "quantity" : 1, "shipfromwarehouseid" : "40", "warehousename" : "Carol Stream, IL", "status" : "C", "statusdescription" : "CREDIT HOLD", "holdreasoncodedescription" : "NO DESCRIPTION", "carriertype" : "LTL", "carriercode" : "OT", "carriername" : "OTHER", "pronumber" : "OTHER" } ], "productextendedspecs" : [ { "attributename" : "ponumber", "attributevalue" : "PO NOT GENERATED YET" } ] } ], "extendedspecs" : [ { "attributename" : "commenttext", "attributevalue" : "HAPPY BIRTHDAY MOM" }, { "attributename" : "commenttext", "attributevalue" : "///THIS ORDER MUST SHIP ON FEDEX" }, { "attributename" : "commenttext", "attributevalue" : "/// 3RD ACCOUNT# 12345678" } ] } } } }, "Order number not found" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "FAILED" }, "orderdetailresponse" : { "ordernumber" : "Not Found", "customerordernumber" : "Not-Found", "orderstatus" : "Not-Found" } } } }, "Shipped Order" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "orderdetailresponse" : { "ordernumber" : "20-V9R37", "ordertype" : "S", "customerordernumber" : "9WYLT4PNC", "enduserponumber" : "20369444086587527", "orderstatus" : "Shipped", "entrytimestamp" : "2020-01-22T09:11:14-08:00", "entrymethoddescription" : "XML/PCG", "ordertotalvalue" : 197.55, "ordersubtotal" : 164.62, "currencycode" : "GBP", "totalweight" : "1.87", "totaltax" : "32.93", "billtoaddress" : { "suffix" : "000", "name" : "AMAZON EU SARL", "addressline1" : "AMAZON EU SARL, UK BRANCH", "addressline2" : "1 PRINCIPAL PLACE", "city" : "LONDON", "postalcode" : "EC2A 2FA", "countrycode" : "UK" }, "shiptoaddress" : { "attention" : "ATTENTION LINE", "name" : "COMPANY NAME HERE", "addressline1" : "ADDRESS LINE 1", "addressline2" : "ADDRESS LINE 2", "city" : "MILTON KEYNES", "postalcode" : "MK9 2EA", "countrycode" : "UK" }, "enduserinfo" : null, "lines" : [ { "linenumber" : "002", "globallinenumber" : "001", "ordersuffix" : "11", "erpordernumber" : "20-V9R37-11", "linestatus" : "Shipped", "partnumber" : "V934027", "manufacturerpartnumber" : "45PAT7MYL", "vendorname" : "STARTECH - CABLES", "vendorcode" : "D825", "partdescription1" : "7M YELLOW CAT5E CABLE", "partdescription2" : "SNAGLESS ETHERNET CABLE - UTP", "unitweight" : "0.36", "unitprice" : 2.04, "extendedprice" : 2.04, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "serialnumberdetails" : [ { "serialnumber" : "011", "deliverynumber" : "1123" } ], "trackingnumber" : [ "10660208" ], "shipmentdetails" : [ { "quantity" : 1, "shipfromwarehouseid" : "10", "warehousename" : "Mira Loma, CA", "status" : "S", "statusdescription" : "Shipped", "holdreasoncodedescription" : "NA", "carriercode" : "4M", "carriername" : "SMARTPOST-BM", "pronumber" : "121", "packagedetails" : [ { "trackingnumber" : "65792630", "packageweight" : "2", "cartonnumber" : "1", "quantityinbox" : "3" } ] } ] }, { "linenumber" : "003", "globallinenumber" : "002", "ordersuffix" : "11", "erpordernumber" : "20-V9R37-11", "linestatus" : "Shipped", "partnumber" : "V934357", "manufacturerpartnumber" : "DK30CHDPPDUE", "vendorname" : "STARTECH - IO NETWORKING", "vendorcode" : "D822", "partdescription1" : "DUAL MONITOR USB C DOCK - POWER", "partdescription2" : "DELIVERY 60W - DUAL 4K DP/HDMI SD", "unitweight" : "1.35", "unitprice" : 143.42, "extendedprice" : 143.42, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "serialnumberdetails" : [ { "serialnumber" : "011", "deliverynumber" : "1123" } ], "trackingnumber" : [ "10660208" ], "shipmentdetails" : [ { "quantity" : 1, "shipfromwarehouseid" : "10", "warehousename" : "Mira Loma, CA", "status" : "S", "statusdescription" : "Shipped", "holdreasoncodedescription" : "NA", "carriercode" : "4M", "carriername" : "SMARTPOST-BM", "pronumber" : "121", "packagedetails" : [ { "trackingnumber" : "65792630", "packageweight" : "2", "cartonnumber" : "1", "quantityinbox" : "3" } ] } ] }, { "linenumber" : "004", "globallinenumber" : "003", "ordersuffix" : "11", "erpordernumber" : "20-V9R37-11", "linestatus" : "Shipped", "partnumber" : "242F880", "manufacturerpartnumber" : "1511B001", "vendorname" : "CANON - SUPPLIES INK HV", "vendorcode" : "M032", "partdescription1" : "CLI-36 INK CARTRIDGE COLOUR", "partdescription2" : "F/ PIXMA MINI260", "unitweight" : "0.05", "unitprice" : 8.88, "extendedprice" : 8.88, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "serialnumberdetails" : [ { "serialnumber" : "011", "deliverynumber" : "1123" } ], "trackingnumber" : [ "10660208" ], "shipmentdetails" : [ { "quantity" : 1, "shipfromwarehouseid" : "10", "warehousename" : "Mira Loma, CA", "status" : "S", "statusdescription" : "Shipped", "holdreasoncodedescription" : "NA", "carriercode" : "4M", "carriername" : "SMARTPOST-BM", "pronumber" : "121", "packagedetails" : [ { "trackingnumber" : "65792630", "packageweight" : "2", "cartonnumber" : "1", "quantityinbox" : "3" } ] } ] }, { "linenumber" : "005", "globallinenumber" : "004", "ordersuffix" : "11", "erpordernumber" : "20-V9R37-11", "linestatus" : "Shipped", "partnumber" : "V931792", "manufacturerpartnumber" : "RJ45SPLITTER", "vendorname" : "STARTECH - CABLES", "vendorcode" : "D825", "partdescription1" : "2-TO-1 RJ45 SPLITTER CABLE", "partdescription2" : "ADAPTER - F/M", "unitweight" : "0.03", "unitprice" : 4.8, "extendedprice" : 4.8, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "serialnumberdetails" : [ { "serialnumber" : "011", "deliverynumber" : "1123" } ], "trackingnumber" : [ "10660208" ], "shipmentdetails" : [ { "quantity" : 1, "shipfromwarehouseid" : "10", "warehousename" : "Mira Loma, CA", "status" : "S", "statusdescription" : "Shipped", "holdreasoncodedescription" : "NA", "carriercode" : "4M", "carriername" : "SMARTPOST-BM", "pronumber" : "121", "packagedetails" : [ { "trackingnumber" : "65792630", "packageweight" : "2", "cartonnumber" : "1", "quantityinbox" : "3" } ] } ] }, { "linenumber" : "006", "globallinenumber" : "005", "ordersuffix" : "11", "erpordernumber" : "20-V9R37-11", "linestatus" : "Shipped", "partnumber" : "V931639", "manufacturerpartnumber" : "HDMM1MHS", "vendorname" : "STARTECH - CABLES", "vendorcode" : "D825", "partdescription1" : "1M HIGH SPEED HDMI CABLE WITH", "partdescription2" : "ETHERNET - HDMI - M/M", "unitweight" : "0.08", "unitprice" : 3.48, "extendedprice" : 3.48, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "serialnumberdetails" : [ { "serialnumber" : "011", "deliverynumber" : "1123" } ], "trackingnumber" : [ "10660208" ], "shipmentdetails" : [ { "quantity" : 1, "shipfromwarehouseid" : "10", "warehousename" : "Mira Loma, CA", "status" : "S", "statusdescription" : "Shipped", "holdreasoncodedescription" : "NA", "carriercode" : "4M", "carriername" : "SMARTPOST-BM", "pronumber" : "121", "packagedetails" : [ { "trackingnumber" : "65792630", "packageweight" : "2", "cartonnumber" : "1", "quantityinbox" : "3" } ] } ] } ], "miscfeeline" : [ { "code" : "895", "description" : "FN PARCELFORCE NEXT DAY", "chargeamount" : "2.00" } ], "extendedspecs" : [ { "attributename" : "commenttext", "attributevalue" : "///CN:CONTACT NAME HERE" } ] } } } } } } } } }, "operationId" : "get-v5-orders-details", "description" : "Use your Ingram Micro sales order number to search for existing orders or retrieve existing order details.\n\n The sales order number, customer number and isoCountryCode are required parameters.\n\n The sales order number is returned in the Order Create POST response. Ingram Micro recommends that you save this number for future uses.\n\n The IM sales order number can also be retrieved by searching for your existing order using the Order Search GET endpoint. You will need the customer PO number or order number that was provided at the time of order creation.\n\n In a case when the IM sales order number is repeated, you can refine the result by providing customer order number for additional filtering or using the date range to filter orders by creation date.\n\n Use the \"simulate\" query parameter to test the GET order response for various order statuses. This parameter is only available in the sandbox to help with development and testing of the GET order endpoint.", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "schema" : { "type" : "string", "default" : "20-222222" }, "in" : "query", "name" : "customernumber", "required" : true, "description" : "Your unique Ingram Micro customer number" }, { "schema" : { "type" : "string", "maxLength" : 2, "default" : "US", "minLength" : 2 }, "in" : "query", "name" : "isocountrycode", "required" : true, "description" : "2 chars ISO country code" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "customerordernumber", "description" : "Your PO/Order Number provide at the time of order creation" }, { "schema" : { "type" : "string", "format" : "date", "example" : "2020-03-15" }, "in" : "query", "name" : "startcreatetimestamp", "description" : "Filter start date - format YYYY-MM-DD" }, { "schema" : { "type" : "string", "example" : "2020-04-20" }, "in" : "query", "name" : "endcreatetimestamp", "description" : "Filter end date - format YYYY-MM-DD" }, { "schema" : { "type" : "string", "enum" : [ "IM::shipped", "IM::invoiced", "IM::hold", "IM::partially_shipped" ], "example" : "" }, "in" : "query", "name" : "simulate", "description" : "Order response for various order statuses. Not for use in production." } ] }, "parameters" : [ { "schema" : { "type" : "string", "example" : "20-RD128" }, "name" : "ordernumber", "in" : "path", "required" : true, "description" : "Ingram Micro sales order number" } ], "delete" : { "summary" : "Cancel an Existing Order", "operationId" : "delete-orders-orderNumber", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderCancelResponse" }, "examples" : { "Example" : { "value" : { "serviceresponse" : { "responsepreamble" : { "requestStatus" : "SUCCESS", "returnCode" : "00", "returnMessage" : "Order Deleted Successfully" } } } } } } } } }, "tags" : [ "Orders v5" ], "security" : [ { "application" : [ "write" ] } ], "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "name" : "customerNumber", "required" : true, "description" : "Your unique Ingram Micro customer number" }, { "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2 }, "in" : "query", "name" : "isoCountryCode", "required" : true, "description" : "2 chars ISO country code" }, { "schema" : { "type" : "string", "default" : "2020-04-03" }, "in" : "query", "name" : "entryDate", "required" : true, "description" : "Order entry date (yyyy-mm-dd)" } ], "description" : "This endpoint is a request to cancel a previously accepted order. Use your Ingram Micro sales order number to cancel an order.\n\n The orderNumber, isoCountryCode, customerNumber and entryDate parameters are required.\n\n This call must be submitted before the order is released to Ingram Micro’s warehouse. The order cannot be canceled once it is released to the warehouse.\n\n Direct ship orders cannot be canceled. Contact your Ingram Micro sales rep for assistance." } }, "/resellers/v5/Catalog/priceandavailability" : { "post" : { "description" : "Search the product catalog for the price and availability for up to 50 SKUs at one time. This endpoint helps to confirm the details just prior to placing a real-time call.", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/priceAndAvailabilityRequest" }, "examples" : { "Ingram Part Number" : { "value" : { "servicerequest" : { "requestpreamble" : { "customernumber" : "20-222223", "isocountrycode" : "US" }, "priceandstockrequest" : { "showwarehouseavailability" : "True", "extravailabilityflag" : "Y", "item" : [ { "ingrampartnumber" : "TB6489", "quantity" : 1 }, { "ingrampartnumber" : "1AQ821", "quantity" : 1 } ], "includeallsystems" : false } } } } } } } }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/priceAndAvailabilityResponse" }, "examples" : { "Example" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS", "statuscode" : "200", "responsemessage" : "Data Found" }, "priceandstockresponse" : { "details" : [ { "itemstatus" : "SUCCESS", "statusmessage" : "3000-SKU not found/replic", "ingrampartnumber" : "TB6489", "vendorpartnumber" : "H1180HD", "globalskuid" : "A300-TB6489", "customerprice" : 0, "partdescription1" : "H1180HD DLP 3D PROJ 2000L 1080PPROJ", "partdescription2" : "10000:1 VGA HDMI RCA", "vendornumber" : "Q680", "vendorname" : "VIVITEK", "cpucode" : "DLP-PR", "class" : "X", "skustatus" : "ACTIVE", "mediacpu" : "PROJ DLP-PR", "categorysubcategory" : "04 25", "retailprice" : 899, "newmedia" : "PROJ", "enduserrequired" : "Y", "backorderflag" : "Y", "skuauthorized" : "Y", "warehousedetails" : [ { "warehouseid" : "30", "warehousedescription" : "Millington, TN", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 0 }, { "warehouseid" : "49", "warehousedescription" : "Electronic Download", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 0 }, { "warehouseid" : "80", "warehousedescription" : "Jonestown, PA", "availablequantity" : 690, "onorderquantity" : 0, "onholdquantity" : 0 }, { "warehouseid" : "40", "warehousedescription" : "Carol Stream, IL", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 0 }, { "warehouseid" : "10", "warehousedescription" : "Mira Loma, CA", "availablequantity" : 781, "onorderquantity" : 2, "onholdquantity" : 0, "etadate" : "2028-07-06" }, { "warehouseid" : "20", "warehousedescription" : "Carrolton, TX", "availablequantity" : 256, "onorderquantity" : 0, "onholdquantity" : 0 } ] }, { "itemstatus" : "SUCCESS", "statusmessage" : "3000-SKU not found/replic", "ingrampartnumber" : "1AQ821", "vendorpartnumber" : "NP940X3M-K03US", "globalskuid" : "A300-1AQ821", "customerprice" : 0, "partdescription1" : "NOTEBOOK 9 PRO I5-7200U 2.5G SYST", "partdescription2" : "128GB SSD 13IN TITAN SILVER Z", "vendornumber" : "QG86", "vendorname" : "SAMSUNG", "cpucode" : "NOTEBK", "class" : "E", "skustatus" : "ACTIVE", "mediacpu" : "SYST NOTEBK", "categorysubcategory" : "00 46", "retailprice" : 949.99, "newmedia" : "SYST", "backorderflag" : "N", "skuauthorized" : "N", "extendedvendorpartnumber" : "NP940X3M-K03US", "warehousedetails" : [ { "warehouseid" : "30", "warehousedescription" : "Millington, TN", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 0 }, { "warehouseid" : "80", "warehousedescription" : "Jonestown, PA", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 0 }, { "warehouseid" : "40", "warehousedescription" : "Carol Stream, IL", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 1 }, { "warehouseid" : "17", "warehousedescription" : "Miami, FL", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 0 }, { "warehouseid" : "10", "warehousedescription" : "Mira Loma, CA", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 0 }, { "warehouseid" : "20", "warehousedescription" : "Carrolton, TX", "availablequantity" : 0, "onorderquantity" : 0, "onholdquantity" : 0 } ] } ] } } } } } } } } }, "tags" : [ "Product Catalog v5" ], "summary" : "Find availability of upto 50 SKUs", "operationId" : "MultiSKUPriceAndStock", "parameters" : [ ], "security" : [ { "application" : [ "read" ] } ] } }, "/resellers/v5/Catalog" : { "get" : { "summary" : "Search Product Catalog", "tags" : [ "Product Catalog v5" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/productSearchResponse" }, "examples" : { "Using Ingram part number" : { "value" : { "serviceresponse" : { "responsepreamble" : { "requeststatus" : "SUCCESS", "returncode" : "200", "returnmessage" : "Data Available" }, "productsearchresponse" : [ { "responseflag" : "1", "partnumbers" : [ { "ingrampartnumber" : "3AR598", "manufacturerpartnumber" : "NP940X5N-X01US", "upccode" : "0887276244266", "productdescription" : "NOTEBOOK 9 PRO 15IN 2018 I7-8550U 256GB SSD", "currency" : "USD", "haswarranty" : "false" } ] } ] } } } } } } } }, "operationId" : "get-v5-catalog-productsearch", "description" : "Search the Ingram Micro product catalog using customerNumber, isoCountryCode and partNumber.", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "schema" : { "type" : "string", "default" : "20-222222" }, "in" : "query", "name" : "customerNumber", "required" : true, "description" : "Your unique Ingram Micro customer number" }, { "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "default" : "US" }, "in" : "query", "name" : "isoCountryCode", "required" : true, "description" : "2 chars country code" }, { "schema" : { "type" : "string", "default" : "1AQ821" }, "in" : "query", "name" : "partNumber", "description" : "Part Number can be ingram part number or vendor part number or customer part number or UPC", "required" : true } ] } }, "/resellers/v5/quote/search" : { "post" : { "summary" : "Search Quotes", "operationId" : "post-v5-quotes-search", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/quoteListResponse" }, "examples" : { "Success" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "orderdetailresponse" : { "ordernumber" : "10-12345", "customerordernumber" : "test order", "enduserponumber" : "ABC", "orderstatus" : "INVOICED", "entrytimestamp" : "2018-07-15T04:31:42-07:00", "entrymethoddescription" : "XML/PCG", "fulfilmentordercode" : "Y", "ordertotalvalue" : 3907.38, "ordersubtotal" : 3907.38, "freightamount" : 141.34, "currencycode" : "USD", "totalweight" : "86", "totaltax" : "0", "billtoaddress" : { "suffix" : "000", "name" : "Ingram Micro", "addressline1" : "123 Ingram Way", "addressline2" : null, "city" : "Irvine", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "shiptoaddress" : { "name" : "Mr Customer", "addressline1" : "123 Main St", "city" : "Anywhere", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "lines" : [ { "globallinenumber" : "001", "ordersuffix" : "11", "linestatus" : "INVOICED", "partnumber" : "3AM612", "manufacturerpartnumber" : "QN75Q8FNBFXZA", "vendorname" : "SAMSUNG - CONSUMER TV", "partdescription1" : "75IN Q8 FLAT 4K UHD HDR SMARTTV", "partdescription2" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE", "freeitempromoflag" : "false", "unitweight" : "75", "unitprice" : 50000.48, "foreignunitprice" : 0, "extendedprice" : 5000.48, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-16", "shipfromwarehouseid" : "40", "warehousename" : "Carol Stream, IL", "invoicenumber" : "1234511", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-16", "carriercode" : "AY", "carriername" : "ORD4708752", "packagedetails" : { "trackingnumber" : 6838019, "packageweight" : 80, "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-11", "vendorcode" : "Q012", "isacopapplied" : "N", "adjustedcost" : "5000.09", "serialnumberdetails" : { "serialnumber" : "07AS3CAK500682" }, "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE" } }, { "globallinenumber" : "002", "ordersuffix" : "21", "linestatus" : "INVOICED", "partnumber" : "2GH590", "manufacturerpartnumber" : "F-ADT-STR-KT-1", "vendorname" : "SAMSUNG - SMART THINGS", "partdescription1" : "ADT HOME SECURITY STARTER KIT", "partdescription2" : "SECURITY STARTER KIT", "freeitempromoflag" : "false", "unitweight" : "5.15", "unitprice" : 500.9, "foreignunitprice" : 0, "extendedprice" : 500.9, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-17", "shipfromwarehouseid" : "80", "warehousename" : "Jonestown, PA", "invoicenumber" : "1234521", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-17", "carriercode" : "RG", "carriername" : "FEDEX GROUND", "packagedetails" : { "trackingnumber" : "017136225260674", "packageweight" : "000000006", "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-21", "vendorcode" : "QG64", "isacopapplied" : "N", "adjustedcost" : "400.99", "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "SECURITY STARTER KIT" } } ], "extendedspecs" : [ { "attributename" : "termscode", "attributevalue" : "300" }, { "attributename" : "termsdescription", "attributevalue" : "NET 30 DAYS" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" } ], "ordertype" : "S", "erpid" : null } } } }, "Customer not found" : { "value" : { "quoteSearchResponse" : { "responsePreamble" : { "responseStatus" : "Failed", "responseStatusCode" : "400", "responseMessage" : "Customer Not Found" }, "totalCount" : 0 } } }, "Invalid sort column" : { "value" : { "quoteSearchResponse" : { "responsePreamble" : { "responseStatus" : "Failed", "responseStatusCode" : "400", "responseMessage" : "Provide valid sort column name" }, "totalCount" : 0 } } } } } } } }, "description" : "This endpoint enables the retrieval and filtering of relevant quote list key criteria data, such as quote number, special bid numbers, end user name, status, and date ranges from the Ingram Micro system. By default, the Quotes endpoint retrieves quotes modified or created within the last 30 days.\n\n Observe these additional parameters:", "security" : [ { "application" : [ "read" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/quoteListRequest" }, "examples" : { "Example" : { "value" : { "quoteSearchRequest" : { "requestPreamble" : { "customerNumber" : "20-222222", "customerContact" : "customer@im.com", "isoCountryCode" : "US" }, "retrieveQuoteRequest" : { "fromDate" : "2019-08-01", "toDate" : "2019-11-01", "pageIndex" : 1, "recordsPerPage" : 5, "sorting" : "desc", "sortingColumnName" : "createdon", "thirdPartySource" : "3RDPIDCONWISE" } } } } } } } }, "tags" : [ "Quotes v5" ] }, "parameters" : [ ] }, "/resellers/v5/quote/{quoteNumber}" : { "get" : { "summary" : "Get Quote Details", "tags" : [ "Quotes v5" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/quoteDetails" }, "examples" : { "Example" : { "value" : { "quoteDetailResponse" : { "responsePreamble" : { "responseStatus" : "Passed", "statusCode" : 200, "responseMessage" : "Records Found" }, "retrieveQuoteResponse" : { "quoteGuid" : "bfce8c7f-de74-ea11-a811-000d3a32deaa", "quoteName" : "USName53", "quoteNumber" : "QUO-25576-C8S2W7", "quoteExpiryDate" : "2020-08-13", "revisionNumber" : "0", "introPreamble" : "Thank you for contacting Ingram Micro. We value your business greatly and will continue to deliver the services you need to retain it. This quote is not intended to represent the entire conversation; only what was relevant to the solution you requested. We make every effort to provide a complete and correct solution. However, the accuracy of the solution provided is dependent on the information gathered. If relevant information is not provided by our customer, Ingram Micro cannot be held responsible. We urge you to review this quote fully, to ensure it reflects all of your required specifications. If you have additional questions, please contact your designated Ingram Micro contact. Remember to reference your Quote Number.Call reference To ensure fastest and most accurate processing of your order, please provide the quote at the time of purchase", "purchaseInstructions" : "For specific pricing and to order the above products, you may : Some product may be orderable on Imonline at http://us-new.ingrammicro.com : Call the Ingram Micro Sales department at 1.800.456.8000; Your PO number;End User; Your fax number; Shipping instructions; End user PO number; End user license, contract or authorization number Thank you for your order!", "legalTerms" : "This offer to sell the listed product(s) is subject to product availability and Ingram Micro's standard terms and conditions that are published on http://www.ingrammicro.com prices are subject to change without notice. Please contact the Ingram Micro Sales desk at 1.800.456.8000 if you have any additional questions.", "accountInfo" : { "accountName" : "INGRAM MICRO CAPS TEST ACCOUNT", "bcn" : "20222222", "phone" : "7166333600" }, "contactInfo" : { "contactName" : "test9 user9", "contactEmail" : null }, "currencyCode" : "USD", "priceDeviationId" : null, "customerNeed" : null, "solutionProposed" : null, "status" : "Active", "created" : "2020-04-02", "modified" : "2020-04-02", "vendorAttributes" : { "estimateId" : "FT93031874YX", "dealId" : "41168951", "vendorName" : "CISCO - HW SWITCHES DT", "vendorSettingMessage" : null }, "endUser" : { "endUserName" : "WAKE FOREST UNIVERSITY", "endUserAddress" : "391 TECHNOLOGY WAY", "endUserAddress2" : null, "endUserAddress3" : null, "endUserCity" : "WINSTON SALEM", "endUserState" : "NC", "endUserEmail" : null, "endUserPhone" : null, "endUserZipCode" : "27101", "endUserContactName" : null, "endUserMarketSegment" : null }, "leasingCalculations" : "Lease Rate 2000", "leasingInstructions" : "Win more opportunities by offering your customers flexible financing solutions with Ingram Micro Financial Solutions.###############Lease pricing is intended to be a good faith estimate and is being used for marketing purposes only. The actual rate and payment amount may vary, and is subject to credit approval in addition to any terms and conditions that may be required." }, "quoteProductList" : [ { "quoteProductGuid" : "cfce8c7f-de74-ea11-a811-000d3a32deaa", "quantity" : "1.0", "comments" : null, "sku" : "9Y6780", "lineNumber" : "1.0", "price" : { "quotePrice" : "1401.85", "msrp" : "2645.00", "extendedMsrp" : "2645.00", "extendedQuotePrice" : "1401.85" }, "description" : "Catalyst 9300 8 x 10GE Network Module, spare", "vendorPartNumber" : "C9300-NM-8X=", "weight" : "1.35", "isSuggestionProduct" : "false", "vpnCategory" : "hwsw", "quoteProductsSupplierPartAuxiliaryId" : "69479607572;0;;", "quoteProductsVendor" : "CISCO - HW SWITCHES DT" } ], "totalQuoteProductCount" : "1", "totalExtendedMsrp" : "2645.00", "totalQuantity" : 1, "totalExtendedQuotePrice" : "1401.85" } } } } } } } }, "operationId" : "get-v5-quotes-details", "description" : "The quote details API provides all quote details associated with the quote number provided.\n\n The “quoteNumber”, “isoCountryCode” and “customerNumber” parameters are required.", "security" : [ { "application" : [ "read" ] } ], "parameters" : [ { "schema" : { "type" : "string", "default" : "20-222222" }, "in" : "query", "name" : "customerNumber", "required" : true, "description" : "Your Ingram Micro unique customer number" }, { "schema" : { "type" : "string", "maxLength" : 2, "minLength" : 2, "default" : "US" }, "in" : "query", "name" : "isoCountryCode", "required" : true, "description" : "" }, { "schema" : { "type" : "string", "default" : "customer" }, "in" : "query", "description" : "Unique identifier used to identify the third party source accessing the services", "name" : "thirdPartySource" } ] }, "parameters" : [ { "schema" : { "type" : "string", "default" : "QUO-25576-C8S2W7" }, "name" : "quoteNumber", "in" : "path", "required" : true, "description" : "Ingram Micro Quote Number" }, { "schema" : { "type" : "string" }, "name" : "thirdPartySource", "in" : "query", "required" : false, "description" : "Unique identifier used to identify the third party source accessing the services " } ] }, "/products/v4/multiskupriceandstock" : { "post" : { "description" : "Find price and availability of up to 50 SKUs in a single request. As you increase the number of items in the request response time will be extended. This transaction must not be used as a continuous cyclical call to populate availability and pricing for your full catalog. Customers that perform this activity will lose access to price and availability.\n\nIngram can provide a Price catalog file and an Inventory file in flat file format, which can be obtained through FTP download. Please contact 1800-616-4665 or Electronic.Services@ingrammicro.com for more information on these files.", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/multiSKUPriceAndStockRequest" }, "examples" : { "Ingram Part Number" : { "value" : "{ \n \"servicerequest\":{\n \"requestpreamble\":{ \n \"customernumber\":\"20-222222\",\n \"isocountrycode\":\"US\"\n },\n \"priceandstockrequest\":{ \n \"showwarehouseavailability\":\"True\",\n \"extravailabilityflag\":\"Y\",\n \"item\":[ \n {\"ingrampartnumber\":\"TB6489\",\"quantity\":1}\n ],\n \"includeallsystems\":false\n }\n }\n}" } } } } }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/multiSKUPriceAndStockResponse" }, "examples" : { } } } } }, "tags" : [ "Product Catalog v4" ], "summary" : "Product availability for upto 50 SKUs", "operationId" : "post-v4-multiskupriceandstock", "parameters" : [ ], "security" : [ { "application" : [ "read" ] } ] } }, "/products/v4/productsearch" : { "post" : { "description" : "A real time search that provides the Ingram Micro part number using the manufacturer part number. This API is helpful to eliminate any errors when a manufactuer has the same part number and Ingram Micro has had to create multiple sku numbers ", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/productSearchRequest" }, "examples" : { "Ingram Part Number" : { "value" : { "servicerequest" : { "requestpreamble" : { "customernumber" : "20-222222", "isocountrycode" : "US" }, "productsearchrequest" : { "searchcriteria" : { "ingrampartnumber" : "TSXML3" } } } } } } } } }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/productSearchResponse" }, "examples" : { "SKU found" : { "value" : { "serviceresponse" : { "responsepreamble" : { "requeststatus" : "SUCCESS", "returnmessage" : "Details Found" }, "productsearchresponse" : [ { "partnumbers" : [ { "ingrampartnumber" : "TSXML3", "manufacturerpartnumber" : "TESTXMLSKU3" } ] } ] } } }, "SKU Not Found" : { "value" : { "serviceresponse" : { "responsepreamble" : { "requeststatus" : "FAILED", "returnmessage" : "PART-NOT-FOUND" } } } } } } } } }, "tags" : [ "Product Catalog v4" ], "summary" : "Real-time Product Search", "parameters" : [ ], "operationId" : "post-v4-productsearch", "security" : [ { "application" : [ "read" ] } ] } }, "/invoices/v4/invoicedetails" : { "post" : { "summary" : "Get Invoice Details", "operationId" : "post-v4-invoicedetails", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/invoiceDetailResponse" } } } } }, "security" : [ { "application" : [ "read" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/invoiceDetailRequest" }, "examples" : { "Test" : { "value" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "invoicedetailrequest" : { "invoicenumber" : "30-13649-13", "customerponumber" : "DH-200732" } } } } } } } }, "description" : "A real-time request that allows the customer to query Ingram Micro for Invoice information for a specific open or shipped order (in the past 9 months). Orders are searched using Ingram Micro Sales Order Number.", "tags" : [ "Invoices v4" ] }, "parameters" : [ ] }, "/orders/v4/ordermodify" : { "post" : { "summary" : "Modify an Existing Order", "operationId" : "post-v4-ordermodify", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderModifyResponse" } } } } }, "security" : [ { "application" : [ "read", "write" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderModifyRequest" } } } }, "tags" : [ "Orders v4" ], "description" : "The order modify transaction allows for changes to be made after the order creation process but before the order is released to Ingram Micro’s warehouse system. Order modify transaction submitted after the order is released will be rejected and will not be applied.\n\nTypes of modifications allowable: Order release, add comment, and carrier change.\nNOTE - Direct Ship orders cannot be modified.\n" } }, "/orders/v4/orderlookup" : { "post" : { "summary" : "Order Search", "operationId" : "post-v4-ordersearch", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderSearchResponse" } } } } }, "description" : "Search your orders using various search parameters", "security" : [ { "application" : [ "read" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderSearchRequest" } } } }, "tags" : [ "Orders v4" ] } }, "/orders/v4/orderdetails" : { "post" : { "summary" : "Get Order Details", "operationId" : "post-v4-orderdetails", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderDetailResponse" }, "examples" : { "Sample" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "orderdetailresponse" : { "ordernumber" : "10-12345", "customerordernumber" : "test order", "enduserponumber" : "ABC", "orderstatus" : "INVOICED", "entrytimestamp" : "2018-07-15T04:31:42-07:00", "entrymethoddescription" : "XML/PCG", "fulfilmentordercode" : "Y", "ordertotalvalue" : 3907.38, "ordersubtotal" : 3907.38, "freightamount" : 141.34, "currencycode" : "USD", "totalweight" : "86", "totaltax" : "0", "billtoaddress" : { "suffix" : "000", "name" : "Ingram Micro", "addressline1" : "123 Ingram Way", "addressline2" : null, "city" : "Irvine", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "shiptoaddress" : { "name" : "Mr Customer", "addressline1" : "123 Main St", "city" : "Anywhere", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "lines" : [ { "globallinenumber" : "001", "ordersuffix" : "11", "linestatus" : "INVOICED", "partnumber" : "3AM612", "manufacturerpartnumber" : "QN75Q8FNBFXZA", "vendorname" : "SAMSUNG - CONSUMER TV", "partdescription1" : "75IN Q8 FLAT 4K UHD HDR SMARTTV", "partdescription2" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE", "freeitempromoflag" : "false", "unitweight" : "75", "unitprice" : 50000.48, "foreignunitprice" : 0, "extendedprice" : 5000.48, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-16", "shipfromwarehouseid" : "40", "warehousename" : "Carol Stream, IL", "invoicenumber" : "1234511", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-16", "carriercode" : "AY", "carriername" : "ORD4708752", "packagedetails" : { "trackingnumber" : 6838019, "packageweight" : 80, "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-11", "vendorcode" : "Q012", "isacopapplied" : "N", "adjustedcost" : "5000.09", "serialnumberdetails" : { "serialnumber" : "07AS3CAK500682" }, "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE" } }, { "globallinenumber" : "002", "ordersuffix" : "21", "linestatus" : "INVOICED", "partnumber" : "2GH590", "manufacturerpartnumber" : "F-ADT-STR-KT-1", "vendorname" : "SAMSUNG - SMART THINGS", "partdescription1" : "ADT HOME SECURITY STARTER KIT", "partdescription2" : "SECURITY STARTER KIT", "freeitempromoflag" : "false", "unitweight" : "5.15", "unitprice" : 500.9, "foreignunitprice" : 0, "extendedprice" : 500.9, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-17", "shipfromwarehouseid" : "80", "warehousename" : "Jonestown, PA", "invoicenumber" : "1234521", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-17", "carriercode" : "RG", "carriername" : "FEDEX GROUND", "packagedetails" : { "trackingnumber" : "017136225260674", "packageweight" : "000000006", "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-21", "vendorcode" : "QG64", "isacopapplied" : "N", "adjustedcost" : "400.99", "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "SECURITY STARTER KIT" } } ], "extendedspecs" : [ { "attributename" : "termscode", "attributevalue" : "300" }, { "attributename" : "termsdescription", "attributevalue" : "NET 30 DAYS" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" } ], "ordertype" : "S", "erpid" : null } } } } } } } } }, "tags" : [ "Orders v4" ], "description" : "A real-time request that allows the customer to query Ingram Micro for detailed information for a specific open or shipped order. Orders are searched using Ingram Micro Sales Order Number.", "security" : [ { "application" : [ "read" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderDetailRequest" }, "examples" : { "Sample" : { "value" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "orderdetailrequest" : { "ordernumber" : "20-B2V9H" } } } } } } } } }, "parameters" : [ ] }, "/orders/v4/orderdelete" : { "post" : { "summary" : "Delete an Order", "operationId" : "post-v4-orderdelete", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderDeleteResponse" }, "examples" : { "Example" : { "value" : { "serviceresponse" : { "responsepreamble" : { "requestStatus" : "SUCCESS", "returnCode" : "00", "returnMessage" : "Order Deleted Successfully" } } } } } } } } }, "tags" : [ "Orders v4" ], "description" : "A real-time request to delete a previously accepted order must be submitted before the order is released to Ingram Micro’s warehouse. After release the order is no longer eligible for deletion. Order delete transaction submitted after the order is released will be rejected and will not be applied. *Direct ship orders cannot be deleted. Contact your sales rep for assistance.", "security" : [ { "application" : [ "write" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderDeleteRequest" }, "examples" : { "Example" : { "value" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customerumber" : "20-222222" }, "OrderDeleteRequestDetails" : { "entryDate" : "2019-01-22", "orderBranch" : "20", "orderNumber" : "RC62Z" } } } } } } } } }, "parameters" : [ ] }, "/orders/v4/ordercreate" : { "post" : { "summary" : "Create a new Order", "operationId" : "post-v4-ordercreate", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderCreateResponse" }, "examples" : { "Sample" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "ordercreateresponse" : { "numberoflineswithsuccess" : "1", "numberoflineswitherror" : "0", "numberoflineswithwarning" : "0", "globalorderid" : "20-RBRN9", "customerponumber" : "H3E", "ordertype" : "S", "ordertimestamp" : "2018-07-18", "invoicingsystemorderid" : "20-RBRN9", "taxamount" : 0, "freightamount" : 0, "totalorderamount" : 0, "shiptoaddress" : { "attention" : null, "name" : null, "addressline1" : null, "addressline2" : null, "city" : null, "state" : null, "postalcode" : null, "countrycode" : null }, "lines" : [ { "linetype" : "P", "globallinenumber" : "002", "partnumber" : "4K9938", "globalskuid" : "A300-4K9938", "freeitempromoflag" : "false", "linenumber" : "4", "carriercode" : "WC", "carrierdescription" : "WILL CALL", "requestedunitprice" : 647.6, "requestedquantity" : 1, "confirmedquantity" : 0, "backorderedquantity" : 1, "backorderetadate" : "2018-05-15", "unitproductprice" : 647.6, "netamount" : 0, "warehouseid" : "40", "ordersuffix" : "11", "isacopapplied" : "Y" } ] } } } } } } } } }, "description" : "The order create transaction is a real-time transaction that allows customers to place standard product and direct ship (licensing and warranties) orders with Ingram Micro using API.", "security" : [ { "application" : [ "write" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/orderCreateRequest" }, "examples" : { "With Ingram Part Number" : { "value" : { "ordercreaterequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "ordercreatedetails" : { "systemid" : "", "customerponumber" : "TESTAPI10156", "billtosuffix" : "000", "shiptoaddress" : { "attention" : "HARRY WELLS", "addressline1" : "THE COMPUTER STORE", "addressline2" : "754 LAS PALMAS DR", "city" : "IRVINE", "state" : "CA", "postalcode" : "926022004", "countrycode" : "US" }, "lines" : [ { "linetype" : "P", "linenumber" : "001", "globalskuid" : "", "quantity" : "1", "ingrampartnumber" : "NE7872" } ], "extendedspecs" : [ { "attributename" : "entrymethod", "attributevalue" : "WEBS" } ] } } } } } } } }, "tags" : [ "Orders v4" ] }, "parameters" : [ ] }, "/quotes/v1/quotedetails" : { "post" : { "summary" : "Get Quote Details", "operationId" : "post-v4-quotedetails", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/quoteDetailsResponse" }, "examples" : { "Example" : { "value" : { "quoteDetailResponse" : { "responsePreamble" : { "responseStatus" : "Passed", "statusCode" : 200, "responseMessage" : "Records Found" }, "retrieveQuoteResponse" : { "quoteGuid" : "bfce8c7f-de74-ea11-a811-000d3a32deaa", "quoteName" : "USName53", "quoteNumber" : "QUO-25576-C8S2W7", "quoteExpiryDate" : "2020-08-13", "revisionNumber" : "0", "introPreamble" : "Thank you for contacting Ingram Micro. We value your business greatly and will continue to deliver the services you need to retain it. This quote is not intended to represent the entire conversation; only what was relevant to the solution you requested. We make every effort to provide a complete and correct solution. However, the accuracy of the solution provided is dependent on the information gathered. If relevant information is not provided by our customer, Ingram Micro cannot be held responsible. We urge you to review this quote fully, to ensure it reflects all of your required specifications. If you have additional questions, please contact your designated Ingram Micro contact. Remember to reference your Quote Number.Call reference To ensure fastest and most accurate processing of your order, please provide the quote at the time of purchase", "purchaseInstructions" : "For specific pricing and to order the above products, you may : Some product may be orderable on Imonline at http://us-new.ingrammicro.com : Call the Ingram Micro Sales department at 1.800.456.8000; Your PO number;End User; Your fax number; Shipping instructions; End user PO number; End user license, contract or authorization number Thank you for your order!", "legalTerms" : "This offer to sell the listed product(s) is subject to product availability and Ingram Micro's standard terms and conditions that are published on http://www.ingrammicro.com prices are subject to change without notice. Please contact the Ingram Micro Sales desk at 1.800.456.8000 if you have any additional questions.", "accountInfo" : { "accountName" : "INGRAM MICRO CAPS TEST ACCOUNT", "bcn" : "20222222", "phone" : "7166333600" }, "contactInfo" : { "contactName" : "test9 user9", "contactEmail" : null }, "currencyCode" : "USD", "priceDeviationId" : null, "customerNeed" : null, "solutionProposed" : null, "status" : "Active", "created" : "2020-04-02", "modified" : "2020-04-02", "vendorAttributes" : { "estimateId" : "FT93031874YX", "dealId" : "41168951", "vendorName" : "CISCO - HW SWITCHES DT", "vendorSettingMessage" : null }, "endUser" : { "endUserName" : "WAKE FOREST UNIVERSITY", "endUserAddress" : "391 TECHNOLOGY WAY", "endUserAddress2" : null, "endUserAddress3" : null, "endUserCity" : "WINSTON SALEM", "endUserState" : "NC", "endUserEmail" : null, "endUserPhone" : null, "endUserZipCode" : "27101", "endUserContactName" : null, "endUserMarketSegment" : null }, "leasingCalculations" : "Lease Rate 2000", "leasingInstructions" : "Win more opportunities by offering your customers flexible financing solutions with Ingram Micro Financial Solutions.###############Lease pricing is intended to be a good faith estimate and is being used for marketing purposes only. The actual rate and payment amount may vary, and is subject to credit approval in addition to any terms and conditions that may be required." }, "quoteProductList" : [ { "quoteProductGuid" : "cfce8c7f-de74-ea11-a811-000d3a32deaa", "quantity" : "1.0", "comments" : null, "sku" : "9Y6780", "lineNumber" : "1.0", "price" : { "quotePrice" : "1401.85", "msrp" : "2645.00", "extendedMsrp" : "2645.00", "extendedQuotePrice" : "1401.85" }, "description" : "Catalyst 9300 8 x 10GE Network Module, spare", "vendorPartNumber" : "C9300-NM-8X=", "weight" : "1.35", "isSuggestionProduct" : "false", "vpnCategory" : "hwsw", "quoteProductsSupplierPartAuxiliaryId" : "69479607572;0;;", "quoteProductsVendor" : "CISCO - HW SWITCHES DT" } ], "totalQuoteProductCount" : "1", "totalExtendedMsrp" : "2645.00", "totalQuantity" : 1, "totalExtendedQuotePrice" : "1401.85" } } } } } } } }, "description" : "A real-time request to delete a previously accepted order must be submitted before the order is released to Ingram Micro’s warehouse. After release the order is no longer eligible for deletion. Order delete transaction submitted after the order is released will be rejected and will not be applied. *Direct ship orders cannot be deleted. Contact your sales rep for assistance.", "security" : [ { "application" : [ "write" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/quoteDetailsRequest" }, "examples" : { "Example" : { "value" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customerumber" : "20-222222" }, "OrderDeleteRequestDetails" : { "entryDate" : "2019-01-22", "orderBranch" : "20", "orderNumber" : "RC62Z" } } } } } } } }, "tags" : [ "Quotes v4" ] }, "parameters" : [ ] }, "/quotes/v1/quotes" : { "post" : { "summary" : "Get Quote List", "operationId" : "post-v4-quotesearch", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/quoteListResponse" }, "examples" : { "Sample" : { "value" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "orderdetailresponse" : { "ordernumber" : "10-12345", "customerordernumber" : "test order", "enduserponumber" : "ABC", "orderstatus" : "INVOICED", "entrytimestamp" : "2018-07-15T04:31:42-07:00", "entrymethoddescription" : "XML/PCG", "fulfilmentordercode" : "Y", "ordertotalvalue" : 3907.38, "ordersubtotal" : 3907.38, "freightamount" : 141.34, "currencycode" : "USD", "totalweight" : "86", "totaltax" : "0", "billtoaddress" : { "suffix" : "000", "name" : "Ingram Micro", "addressline1" : "123 Ingram Way", "addressline2" : null, "city" : "Irvine", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "shiptoaddress" : { "name" : "Mr Customer", "addressline1" : "123 Main St", "city" : "Anywhere", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "lines" : [ { "globallinenumber" : "001", "ordersuffix" : "11", "linestatus" : "INVOICED", "partnumber" : "3AM612", "manufacturerpartnumber" : "QN75Q8FNBFXZA", "vendorname" : "SAMSUNG - CONSUMER TV", "partdescription1" : "75IN Q8 FLAT 4K UHD HDR SMARTTV", "partdescription2" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE", "freeitempromoflag" : "false", "unitweight" : "75", "unitprice" : 50000.48, "foreignunitprice" : 0, "extendedprice" : 5000.48, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-16", "shipfromwarehouseid" : "40", "warehousename" : "Carol Stream, IL", "invoicenumber" : "1234511", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-16", "carriercode" : "AY", "carriername" : "ORD4708752", "packagedetails" : { "trackingnumber" : 6838019, "packageweight" : 80, "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-11", "vendorcode" : "Q012", "isacopapplied" : "N", "adjustedcost" : "5000.09", "serialnumberdetails" : { "serialnumber" : "07AS3CAK500682" }, "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE" } }, { "globallinenumber" : "002", "ordersuffix" : "21", "linestatus" : "INVOICED", "partnumber" : "2GH590", "manufacturerpartnumber" : "F-ADT-STR-KT-1", "vendorname" : "SAMSUNG - SMART THINGS", "partdescription1" : "ADT HOME SECURITY STARTER KIT", "partdescription2" : "SECURITY STARTER KIT", "freeitempromoflag" : "false", "unitweight" : "5.15", "unitprice" : 500.9, "foreignunitprice" : 0, "extendedprice" : 500.9, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-17", "shipfromwarehouseid" : "80", "warehousename" : "Jonestown, PA", "invoicenumber" : "1234521", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-17", "carriercode" : "RG", "carriername" : "FEDEX GROUND", "packagedetails" : { "trackingnumber" : "017136225260674", "packageweight" : "000000006", "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-21", "vendorcode" : "QG64", "isacopapplied" : "N", "adjustedcost" : "400.99", "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "SECURITY STARTER KIT" } } ], "extendedspecs" : [ { "attributename" : "termscode", "attributevalue" : "300" }, { "attributename" : "termsdescription", "attributevalue" : "NET 30 DAYS" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" } ], "ordertype" : "S", "erpid" : null } } } } } } } } }, "description" : "A real-time request that allows the customer to query Ingram Micro for detailed information for a specific open or shipped order. Orders are searched using Ingram Micro Sales Order Number.", "security" : [ { "application" : [ "read" ] } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/quoteListRequest" }, "examples" : { "Sample" : { "value" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "orderdetailrequest" : { "ordernumber" : "20-B2V9H" } } } } } } } }, "tags" : [ "Quotes v4" ] }, "parameters" : [ ] } }, "servers" : [ { "url" : "https://api.ingrammicro.com:443/sandbox", "description" : "Sandbox" } ], "components" : { "schemas" : { "OrderDetailsV7Response": { "type": "object", "description": "Complete response schema for the Order Details v7 endpoint.", "properties": { "customerOrderNumber": { "type": "string", "description": "Reseller's purchase order number." }, "confirmationNumber": { "type": "string", "description": "Async confirmationNumber from Order Create V7. null if placed via other channels." }, "ingramOrderNumber": { "type": "string", "description": "Ingram Micro order number (e.g. 20-Y6T03)." }, "ingramOrderDate": { "type": "string", "format": "date-time", "description": "Date and time the order was placed in UTC format." }, "orderStatus": { "type": "string", "description": "Current order status ", "enum": [ "OPEN", "BACKORDERED", "SALES_HOLD", "CREDIT_REVIEW", "PARTIALLY_SHIPPED", "SHIPPED", "PARTIALLY_DELIVERED", "DELIVERED", "CANCELLED", "COMPLETED", "IN_PROGRESS", "PARTIALLY_PROCESSED", "VOIDED", "ORDER_REVIEW", "CREDIT_CHECK", "PROCESSING", "READY_TO_SHIP", "READY_FOR_PICKUP", "PROVISIONING_FAILED", "ACTION_REQUIRED", "SCHEDULED", "PENDING_APPROVAL", "ACTIVATION_DATE_VALIDATION_FAILED", "PENDING_TERMS_AND_ACCEPTANCE", "ACTION_REQUIRED_PROVISIONING_IN_PROGRESS", "ORDER_FULFILLMENT" ] }, "orderStatusDescription": { "type": "string", "description": "Description of the order status." }, "orderType": { "type": "string", "description": "Order type code: S = Stocked, CLD = Cloud/Subscription, D = Direct ship." }, "orderTotal": { "type": "number", "format": "double", "description": "Total order amount including all lines, freight, and taxes." }, "currencyCode": { "type": "string", "description": "ISO currency code (e.g. EUR, USD)." }, "paymentTerms": { "type": "string", "description": "Payment terms of the order (e.g. PREPAYMENT, NET 20 DAYS)." }, "endCustomerOrderNumber": { "type": "string", "description": "End customer's purchase order number." }, "vendorSalesOrderNumber": { "type": "string", "description": "The vendor's order number. Only for DirectShip orders." }, "ingramPurchaseOrderNumber": { "type": "string", "description": "Ingram Micro purchase order number." }, "orderSubTotal": { "type": "number", "format": "double", "description": "Order subtotal before taxes." }, "freightCharges": { "type": "number", "format": "double", "description": "The freight charges for the order." }, "totalWeight": { "type": "number", "format": "double", "description": "Total order weight." }, "totalTax": { "type": "number", "format": "double", "description": "Aggregated tax amount, also reflected in miscellaneousCharges[] as a GST reference line." }, "totalFees": { "type": "number", "format": "double", "description": "Aggregated miscellaneous fees. Breakdown in miscellaneousCharges[]." }, "quoteNumber": { "type": "string", "description": "Quote number for Quote-to-Order traceability." }, "specialBidNumber":{ "type": "string", "description": "Bid number provided to the reseller by the vendor for special pricing and discounts." }, "notes":{ "type": "string", "description": "Header-level notes for the order." }, "smartAccountNumber": { "type": "string", "description": "Cisco smart account number." }, "dealID": { "type": "string", "description": "Deal ID for special bid / deal-based orders." }, "resellerTcv": { "type": "string", "description": "Reseller total contract value." }, "billToInfo": { "type": "object", "description": "The billing information provided by the reseller.", "properties": { "contact": { "type": "string", "description": "Contact name for billing." }, "companyName": { "type": "string", "description":"Company name for billing." }, "addressLine1": { "type": "string", "description":"Primary address line." }, "addressLine2": { "type": "string", "description":"Secondary address line." }, "addressLine3": { "type": "string", "description":"Tertiary address line." }, "city": { "type": "string", "description":"City" }, "state": { "type": "string", "description":"State or province." }, "postalCode": { "type": "string", "description":"Postal or ZIP code." }, "countryCode": { "type": "string", "description":"ISO country code." }, "phoneNumber": { "type": "string", "description":"Phone number." }, "email": { "type": "string", "description":"Email address." } } }, "shipToInfo": { "type": "object", "description": "The shipping information provided by the reseller for order delivery.", "properties": { "contact": { "type": "string", "description": "Contact name for shipping." }, "companyName": { "type": "string", "description": "Company name for shipping. (The reseller's company name or the End-User's Name)" }, "addressLine1": { "type": "string", "description": "Primary address line." }, "addressLine2": { "type": "string", "description": "Secondary address line." }, "addressLine3": { "type": "string", "description": "Tertiary address line." }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province." }, "postalCode": { "type": "string", "description": "Postal or ZIP code." }, "countryCode": { "type": "string", "description": "ISO country code." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "email": { "type": "string", "description": "Email address." } } }, "endUserInfo": { "type": "object", "description": "Contact information for the end user/customer. Used to determine pricing and discounts.", "properties": { "contact": { "type": "string", "description": "Contact name." }, "companyName": { "type": "string", "description": "Company name." }, "addressLine1": { "type": "string", "description": "Primary address line." }, "addressLine2": { "type": "string", "description": "Secondary address line." }, "addressLine3": { "type": "string", "description": "Tertiary address line." }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province." }, "postalCode": { "type": "string", "description": "Postal or ZIP code." }, "countryCode": { "type": "string", "description": "ISO country code." }, "phoneNumber": { "type": "string", "description": "Phone number." }, "email": { "type": "string", "description": "Email address." } } }, "invoices": { "type": "array", "description": "invoice.", "items": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Shipment ID associated with the invoice." }, "invoiceNumber": { "type": "string", "description": "Ingram Micro invoice number." }, "invoiceDate": { "type": "string", "format": "date-time", "description": "Date the invoice was created." } } } }, "vendorRequestedInformation": { "type": "array", "description": "Vendor-requested attributes captured at order time.", "items": { "type": "object", "properties": { "vendorName": { "type": "string", "description": "Name of the vendor requesting the information." }, "name": { "type": "string", "description": "Attribute name." }, "value": { "type": "string", "description": "Attribute value." } } } }, "lines": { "type": "array", "description": "Order line details", "items": { "type": "object", "properties": { "subOrderNumber": { "type": "string", "description": "Sub order number. Two-digit prefix = warehouse code, middle = order number, two-digit suffix = sub order number (e.g. 29-Y6T03-11)." }, "ingramOrderLineNumber": { "type": "string", "description": "Ingram Micro line number within the order (e.g. 001)." }, "vendorSalesOrderLineNumber": { "type": "string", "description": "The vendor's sales order line number." }, "customerLineNumber": { "type": "string", "description": "Customer's line number reference." }, "lineStatus": { "type": "string", "description": "Status for the line item. One of: BACKORDERED, IN PROGRESS, SHIPPED, DELIVERED, CANCELED, ON HOLD." }, "ingramPartNumber": { "type": "string", "description": "Ingram Micro part number." }, "vendorPartNumber": { "type": "string", "description": "Vendor's part number (e.g. N6PATC1MBK)." }, "vendorName": { "type": "string", "description": "Vendor name (e.g. STARTECH)." }, "partDescription": { "type": "string", "description": "Product description." }, "upcCode": { "type": "string", "description": "The UPC code of the product." }, "unitPrice": { "type": "number", "format": "double", "description": "The unit price of the line item." }, "extendedPrice": { "type": "number", "format": "double", "description": "Unit price x quantity for the line item." }, "currencyCode": { "type": "string", "description": "Country-specific three-character ISO 4217 currency code." }, "quantityOrdered": { "type": "integer", "description": "The quantity ordered of the line item." }, "quantityConfirmed": { "type": "integer", "description": "The quantity allocated prior to shipment. May return 0 for shipped lines in V7." }, "quantityBackOrdered": { "type": "integer", "description": "The quantity on backorder for the line item." }, "quantityShipped": { "type": "integer", "description": "The quantity physically shipped for the line item." }, "allocatedInStock": { "type": "integer", "description": "Quantity allocated from warehouse stock." }, "allocatedInboundPO": { "type": "integer", "description": "Quantity allocated from inbound PO." }, "allocatedPO": { "type": "integer", "description": "Quantity allocated to Purchase Order." }, "unitWeight": { "type": "number", "format": "double", "description": "Unit weight of the product." }, "weightUom": { "type": "string", "description": "Weight unit of measure (e.g. kgs, lbs)." }, "specialBidNumber": { "type": "string", "description": "Line-level bid number. Takes precedence over header-level bid numbers." }, "requestedDeliveryDate": { "type": "string", "description": "Reseller-requested delivery date. Delivery date is not guaranteed." }, "promisedDeliveryDate": { "type": "string", "description": "The delivery date promised by Ingram Micro." }, "backOrderETADate": { "type": "string", "description": "ETA date for backordered items." }, "lineNotes": { "type": "string", "description": "Line-level notes." }, "shipmentDetails": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The quantity shipped of the line item." }, "shippedDateTime": { "type": "string", "format": "date-time", "description": "Actual ship date/time." }, "estimatedDeliveryDate": { "type": "string", "description": "Estimated delivery date." }, "shipFromWarehouseId": { "type": "string", "description": "Warehouse ID from which the order shipped." }, "shipFromLocation": { "type": "string", "description": "Ship from location (e.g. MIRA LOMA, CA)." }, "shipFromPincode": { "type": "string", "description": "Pin/postal code of the origin warehouse." }, "estimatedShipDate": { "type": "array", "description": "Estimated ship date range(s) for the line item. Returns null for lines that have already shipped.", "items": { "type": "object", "properties": { "fromDate": { "type": "string", "description": "Start of the estimated ship date range." }, "toDate": { "type": "string", "description": "End of the estimated ship date range." }, "quantity": { "type": "integer", "description": "Quantity associated with this date window." }, "description": { "type": "string", "description": "Description of the estimated ship date." } } } }, "carrierDetails": { "type": "array", "items": { "type": "object", "properties": { "carrierCode": { "type": "string", "description": "Ingram Micro carrier code for the shipment (e.g. UG)." }, "alternateCarrierCode": { "type": "string", "description": "Vendor carrier code when Direct Ship; actual carrier code from carrier system for Stocked (e.g. UPSN)." }, "carrierName": { "type": "string", "description": "Name of the carrier (e.g. UPS GROUND)." }, "quantity": { "type": "integer", "description": "The quantity shipped of the line item." }, "shippedDate": { "type": "string", "description": "The actual date when the line item shipped." }, "estimatedDeliveryDate": { "type": "string", "description": "The date the line item is expected to be delivered." }, "deliveredDate": { "type": "string", "description": "The actual date of delivery of the line item." }, "carrierPickupDate": { "type": "string", "description": "The actual date when the carrier picked up the line item." }, "trackingDetails": { "type": "object", "description": "Tracking details for the shipment containing the line item.", "properties": { "trackingNumber": { "type": "string", "description": "The tracking number for the shipment." }, "trackingUrl": { "type": "string", "description": "The tracking URL for the shipment." }, "quantityInBox": { "type": "integer", "description": "The quantity of line items in the box." }, "serialNumbers": { "type": "array", "items": { "type": "object", "properties": { "serialNumber": { "type": "string", "description": "Individual serial number." } } } }, "imeiNumbers": { "type": "array", "description": "IMEI numbers for mobile devices and IoT products if available.", "items": { "type": "string" } } } } } } } } } }, "serviceContractInfo": { "type": "object", "properties": { "contractInfo": { "type": "array", "items": { "type": "object", "properties": { "contractDescription": { "type": "string", "description": "Description of the service contract." }, "contractNumber": { "type": "string", "description": "Contract number." }, "contractStatus": { "type": "string", "description": "The status of the contract." }, "contractStartDate": { "type": "string", "description": "Contract start date." }, "contractEndDate": { "type": "string", "description": "Contract end date." }, "contractDuration": { "type": "string", "description": "Duration of the contract." }, "vpn": { "type": "string", "description": "Vendor part number associated with the contract." } } } }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "Unique subscription identifier." }, "subscriptionTerm": { "type": "string", "description": "Subscription term." }, "renewalTerm": { "type": "string", "description": "Renewal term." }, "billingModel": { "type": "string", "description": "Billing model (e.g. YEAR, MONTH)." }, "subcriptionStartDate": { "type": "string", "description": "Subscription start date." }, "subcriptionEndDate": { "type": "string", "description": "Subscription end date." } } } }, "licenseInfo": { "type": "array", "items": { "type": "object", "properties": { "licenseNumber": { "type": "string", "description": "License number(s)." }, "licenseStartDate": { "type": "string", "description": "License start date." }, "licenseEndDate": { "type": "string", "description": "License end date." }, "description": { "type": "string", "description": "License description." }, "quantity": { "type": "string", "description": "Number of licenses." } } } } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string", "description": "Topic or relation type of the link." }, "href": { "type": "string", "description": "URL of the linked resource." }, "type": { "type": "string", "description": "HTTP method or content type of the link." } } } } } } }, "cmpLines": { "type": "array", "description": "Cloud marketplace subscription lines", "items": { "type": "object", "properties": { "lineNumber": { "type": "string", "description": "Line number for the subscription order." }, "plan": { "type": "string", "description": "Subscription plan name." }, "vendorPartNumber": { "type": "string", "description": "Vendor part number for the cloud product." }, "notes": { "type": "string", "description": "Line-level notes." }, "subOrderNumber": { "type": "string", "description": "Sub-order number." }, "subscriptions": { "type": "object", "properties": { "requestedStartDate": { "type": "string", "description": "Requested start date for the subscription." }, "startDate": { "type": "string", "description": "Actual subscription start date." }, "endDate": { "type": "string", "description": "Subscription end date." } } }, "billingFrequency": { "type": "string", "description": "Billing frequency." }, "renewalTerm": { "type": "string", "description": "Renewal term for the subscription." }, "childLines": { "type": "array", "items": { "type": "object", "properties": { "lineNumber": { "type": "string", "description": "Child line number within this subscription line." }, "options": { "type": "string", "description": "Configuration options for this child line." }, "terms": { "type": "string", "description": "Term type." }, "termsDuration": { "type": "string", "description": "Duration of the term." }, "quantity": { "type": "integer", "description": "Quantity ordered." }, "resellerUnitPrice": { "type": "number", "format": "double", "description": "Reseller unit price." }, "unitOfMeasure": { "type": "string", "description": "Unit of measure (e.g. Licenses)." }, "resellerLinePrice": { "type": "number", "format": "double", "description": "Total reseller line price." }, "margin": { "type": "string", "description": "Reseller margin %." }, "endCustomerUnitPrice": { "type": "number", "format": "double", "description": "End customer unit price." }, "endCustomerLinePrice": { "type": "number", "format": "double", "description": "Total end customer line price." } } } } } } }, "miscellaneousCharges": { "type": "array", "items": { "type": "object", "properties": { "subOrderNumber": { "type": "string", "description": "Sub-order number this charge belongs to." }, "chargeLineReference": { "type": "string", "description": "Ingram Micro charge reference code." }, "chargeDescription": { "type": "string", "description": "Charge description (e.g. FREIGHT CHARGE, STATETAX, RECYCLING FEE BC)." }, "chargeAmount": { "type": "string", "description": "Charge amount as a string." } } } }, "customerOrderTotals": { "type": "object", "properties": { "subTotal": { "type": "string", "description": "Cloud order subtotal." }, "total": { "type": "string", "description": "Cloud order total." }, "totalFees": { "type": "string", "description": "Total fees for the cloud order." }, "totalTaxes": { "type": "string", "description": "Total taxes for the cloud order." }, "customerTcv": { "type": "string", "description": "Customer total contract value." } } }, "additionalAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "Name of the attribute." }, "attributeValue": { "type": "string", "description": "Value of the attribute." } } } } } }, "OrderSearchV7Response":{ "type": "object", "description": "Order search response", "properties": { "recordsFound": { "type": "integer", "description": "Total number of orders matching the query across all pages." }, "pageSize": { "type": "integer", "description": "Number of records returned per page. Default is 25." }, "pageNumber": { "type": "integer", "description": "Current page number. Default is 1." }, "orders": { "type": "array", "description": "The details for the orders.", "items": { "type": "object", "properties": { "ingramOrderNumber": { "type": "string", "description": "Ingram Micro order number." }, "ingramOrderDate": { "type": "string", "format": "date-time", "description": "Date and time the order was placed (UTC)." }, "customerOrderNumber": { "type": "string", "description": "Reseller's purchase order number." }, "orderType": { "type": "string", "description": "Type of order.", "enum": ["Stocked", "DirectShip", "Cloud"] }, "vendorSalesOrderNumber": { "type": "string", "description": "The vendor's order number. Only applicable for DirectShip orders." }, "vendorName": { "type": "string", "description": "Vendor name." }, "endUserCompanyName": { "type": "string", "description": "End customer company name." }, "confirmationNumber": { "type": "string", "description": "Async confirmationNumber from Order Create V7. Only for orders created with V7." }, "ingramPurchaseOrderNumber": { "type": "string", "description": "Ingram Micro purchase order number." }, "orderPlacedBy": { "type": "string", "description": "Name of the user or system that placed the order." }, "orderTotal": { "type": "number", "format": "double", "description": "Total order amount in the account currency." }, "orderStatus": { "type": "string", "description": "Current header-level order status.", "enum": [ "OPEN", "BACKORDERED", "SALES_HOLD", "CREDIT_REVIEW", "PARTIALLY_SHIPPED", "SHIPPED", "PARTIALLY_DELIVERED", "DELIVERED", "CANCELLED", "COMPLETED", "IN_PROGRESS", "PARTIALLY_PROCESSED", "VOIDED", "ORDER_REVIEW", "CREDIT_CHECK", "PROCESSING", "READY_TO_SHIP", "READY_FOR_PICKUP", "PROVISIONING_FAILED", "ACTION_REQUIRED", "SCHEDULED", "PENDING_APPROVAL", "ACTIVATION_DATE_VALIDATION_FAILED", "PENDING_TERMS_AND_ACCEPTANCE", "ACTION_REQUIRED_PROVISIONING_IN_PROGRESS", "ORDER_FULFILLMENT" ] }, "eta": { "type": "string", "description": "Estimated ship date when available. Example: Estimated to ship on,2026-03-24T00:00:00" }, "subOrders": { "type": "array", "description": "Sub-order details for the order.", "items": { "type": "object", "properties": { "subOrderNumber": { "type": "string", "description": "Sub order number. Prefix indicates warehouse, middle is order number, suffix is sub order number." }, "subOrderType": { "type": "string", "description": "Sub-order type." }, "subOrderStatus": { "type": "string", "description": "Current sub-order status.", "enum": [ "PROCESSING", "SHIPPED", "CANCELLED", "BACKORDERED", "ON_HOLD", "CREDIT_REVIEW", "SUBMITTED", "READY_TO_SHIP" ] }, "subOrderStatusDescription": { "type": "string", "description": "Human-readable sub-order status description." }, "subOrderTotal": { "type": "number", "format": "double", "description": "Sub-order total amount." } } } }, "links": { "type": "object", "description": "Links related to the order.", "properties": { "href": { "type": "string", "description": "Link to Order Details for the order." }, "type": { "type": "string", "description": "HTTP method for the linked resource.", "example": "GET" } } } } } }, "nextPage": { "type": "string", "description": "URL path for the next page when more records exist." }, "previousPage": { "type": "string", "description": "URL path for the previous page." } } }, "OrderCreateRequest" : { "type" : "object", "required" : [ "customerOrderNumber" ], "properties" : { "customerOrderNumber" : { "type" : "string", "maxLength" : 18, "description" : "The reseller's unique PO/Order number." }, "endCustomerOrderNumber" : { "type" : "string", "maxLength" : 18, "description" : "The end user/customer's Purchase Order number." }, "billToAddressId" : { "type" : "string", "maxLength" : 10, "description" : "Suffix used to identify billing address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit." }, "specialBidNumber" : { "type" : "string", "description" : "The bid number provided to the reseller by the vendor for special pricing and discounts. Line-level bid numbers take precedence over header-level bid numbers." }, "notes" : { "type" : "string", "description" : "Order level notes." }, "acceptBackOrder" : { "type" : "boolean", "description" : "ENUM [\"true\",\"false\"] - accept order if this item is backordered. This field along with shipComplete field decides the value of backorderflag. The value of this field is ignored when shipComplete field is present." }, "resellerInfo" : { "type" : "object", "description" : "The address and contact information provided by the reseller.", "properties" : { "resellerId" : { "type" : "string", "description" : "The reseller's Id." }, "companyName" : { "type" : "string", "maxLength" : 40, "description" : "The reseller's company name." }, "contact" : { "type" : "string", "description" : "The reseller's contact name." }, "addressLine1" : { "type" : "string", "maxLength" : 70, "description" : "The reseller's street address." }, "addressLine2" : { "type" : "string", "maxLength" : 70, "description" : "The reseller's building or apartment number." }, "city" : { "type" : "string", "maxLength" : 25, "description" : "The reseller's city." }, "state" : { "type" : "string", "maxLength" : 3, "description" : "The reseller's state." }, "postalCode" : { "type" : "string", "maxLength" : 10, "description" : "The reseller's zip or postal code." }, "countryCode" : { "type" : "string", "maxLength" : 10, "description" : "The reseller's two-character ISO country code." }, "phoneNumber" : { "type" : "integer", "description" : "The reseller's phone number." }, "email" : { "type" : "string", "description" : "The reseller's email address." } } }, "vmf" : { "type" : "object", "description" : "Vendor mandatory fields, this is required in case of warranty orders.", "properties" : { "vendAuthNumber" : { "type" : "string", "description" : "Authorization number provided by vendor to Ingram's reseller. Orders will be placed on hold without this value, vendor specific mandatory field - please reach out Ingram Sales team for list of vendor for whom this is mandatory." } } }, "shipToInfo" : { "type" : "object", "description" : "The shipping information provided by the reseller.", "properties" : { "addressId" : { "type" : "string", "maxLength" : 10, "description" : "The ID references the resellers address in Ingram Micro's system for shipping. Provided to resellers during the onboarding process." }, "contact" : { "type" : "string", "maxLength" : 70, "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "maxLength" : 40, "description" : "The reseller's company name or the End-User's Name" }, "addressLine1" : { "type" : "string", "maxLength" : 70, "description" : "The street address and building or house number the order will be shipped to." }, "addressLine2" : { "type" : "string", "maxLength" : 70, "description" : "The apartment number the order will be shipped to." }, "city" : { "type" : "string", "maxLength" : 25, "description" : "The city the order will be shipped to." }, "state" : { "type" : "string", "maxLength" : 3, "description" : "The state the order will be shipped to." }, "postalCode" : { "type" : "string", "maxLength" : 10, "description" : "The zip or postal code the order will be shipped to." }, "countryCode" : { "type" : "string", "maxLength" : 10, "description" : "The two-character ISO country code the order will be shipped to." }, "phoneNumber" : { "type" : "string", "description" : "The company contact phone number." }, "email" : { "type" : "string", "description" : "The company contact email address." } } }, "endUserInfo" : { "type" : "object", "description" : "The contact information for the end user/customer provided by the reseller. Used to determine pricing and discounts.", "properties" : { "endUserId" : { "type" : "string", "description" : "ID for the end user/customer in Ingram Micro's system." }, "contact" : { "type" : "string", "maxLength" : 70, "description" : "The contact name for the end user/customer." }, "companyName" : { "type" : "string", "maxLength" : 40, "description" : "The company name for the end user/customer. Required for Impulse countries." }, "addressLine1" : { "type" : "string", "maxLength" : 70, "description" : "The end user/customer's street address and building or house number. Required for Impulse countries." }, "addressLine2" : { "type" : "string", "maxLength" : 70, "description" : "The end user/customer's apartment number." }, "city" : { "type" : "string", "maxLength" : 25, "description" : "The end user/customer's city. Required for Impulse countries." }, "state" : { "type" : "string", "maxLength" : 3, "description" : "The end user/customer's state. Required for Impulse countries but optional for EMEA countries." }, "postalCode" : { "type" : "string", "maxLength" : 10, "description" : "The end user/customer's zip or postal code. Required for Impulse countries." }, "countryCode" : { "type" : "string", "maxLength" : 10, "description" : "The end user/customer's two-character ISO country code." }, "phoneNumber" : { "type" : "integer", "description" : "The end user/customer's phone number." }, "email" : { "type" : "string", "description" : "The end user/customer's email." } } }, "lines" : { "type" : "array", "description" : "The line-level details of the order.", "items" : { "type" : "object", "properties" : { "customerLineNumber" : { "type" : "string", "maxLength" : 3, "description" : "The reseller's line item number for reference in their system. The customer line number needs to be a unique numeric value between 1 and 884. In the event we receive duplicate values or alphanumeric values in the customer line number, we will re-sequence the customer line number. To prevent re-sequencing, please use a unique numeric value between 1 and 884 in the customer line number." }, "ingramPartNumber" : { "type" : "string", "maxLength" : 18, "description" : "The unique IngramMicro part number." }, "quantity" : { "type" : "integer", "description" : "The requested quantity of the line item." }, "specialBidNumber" : { "type" : "string", "maxLength" : 36, "description" : "The line-level bid number provided to the reseller by the vendor for special pricing and discounts. Used to track the bid number in the case of split orders or where different line items have different bid numbers. Line-level bid number take precedence over header-level bid numbers." }, "notes" : { "type" : "string", "description" : "Line-level notes." }, "unitPrice" : { "type" : "number", "format" : "decimal", "description" : "The reseller-requested unit price for the line item. The unit price is not guaranteed." }, "endUserPrice" : { "type" : "number", "format" : "decimal", "description" : "The end-user price. Required for Export Orders." }, "additionalAttributes" : { "type" : "array", "items" : { "properties" : { "attributeName" : { "type" : "string", "description" : "SAP requested and country-specific line level details." }, "attributeValue" : { "type" : "string", "description" : "Line-level additional attributes." } } } }, "warrantyInfo" : { "type" : "array", "description" : "Warranty details for the line. This is required in case of warranty orders.", "items" : { "type" : "object", "properties" : { "directLineLink" : { "type" : "string", "maxLength" : 25, "description" : "Unique value to link hardware and warranty lines. Should be used only when products are purchased from both Ingram and/or vendor but the warranty is purchased through Ingram for them." }, "warrantyLineLink" : { "type" : "string", "description" : "Customer line number of the hardware product in this request for linkage, either hardwareLineLink or warrantyLineLink can be used in a line." }, "hardwareLineLink" : { "type" : "string", "description" : "Customer line number of the warranty product in this request for linkage, either hardwareLineLink or warrantyLineLink can be used in a line " }, "serialInfo" : { "type" : "array", "description" : "Serial information of the hardware to be associated with the warranty, applicable on post sale orders.", "items" : { "properties" : { "dateofPurchase" : { "type" : "string", "maxLength" : 8, "format" : "date", "description" : "Date of purchase of the hardware." }, "shipDate" : { "type" : "string", "maxLength" : 8, "format" : "date", "description" : "Vendor specific mandatory field, date of hardware/product shipment from vendor." }, "primarySerialNumber" : { "type" : "string", "description" : "Serial number of the hardware/product." }, "secondarySerialNumber" : { "type" : "string", "description" : "Serial number of accessory associated with the above hardware/product." } } } } } } }, "endUserInfo" : { "type" : "array", "items" : { "properties" : { "endUserType" : { "type" : "string", "description" : "Specifies the type of endUser. It can be endUser or endUserContact for SAP flow." }, "endUserId" : { "type" : "string", "maxLength" : 10, "description" : "ID for the end user/customer in Ingram Micro's system." }, "contact" : { "type" : "string", "description" : "The contact name for the end user/customer." }, "companyName" : { "type" : "string", "description" : "The company name for the end user/customer." }, "addressLine1" : { "type" : "string", "description" : "The end user/customer's street address and building or house number." }, "addressLine2" : { "type" : "string", "description" : "The end user/customer's apartment number." }, "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", "maxLength" : 3, "description" : "The end user/customer's two-character ISO country code." }, "phoneNumber" : { "type" : "number", "maxLength" : 30, "description" : "The end user/customer's phone number." }, "email" : { "type" : "string", "maxLength" : 241, "description" : "The end user/customer's email." } } } } } } }, "shipmentDetails" : { "type" : "object", "description" : "Shipping details for the order provided by the customer.", "properties" : { "carrierCode" : { "type" : "string", "maxLength" : 2, "description" : "The code for the shipping carrier for the line item." }, "freightAccountNumber" : { "type" : "string", "description" : "The reseller 's shipping account number with carrier. Used to bill the shipping carrier directly from the reseller's account with the carrier." }, "shipComplete" : { "type" : "string", "maxLength" : 1, "description" : "Specifies whether the shipment will be shipped only when all products are fulfilled. The value of this field along with acceptBackOrder field decides the value of backorderflag. If this field is set, acceptBackOrder field is ignored. Possible values for this field are true, C, P, E. \n\n With value as true or C, backorderflag will be set as C. \n\n With value as P, or E, backorderflag will be set as P or E respectively. \n\n C = Ship complete at distribution level. \n\n P = ship complete at line level. \n\n E = ship complete across all distributions. " }, "requestedDeliveryDate" : { "type" : "string", "maxLength" : 8, "format" : "date", "description" : "The reseller-requested delivery date in UTC format. Delivery date is not guaranteed. Must be a future date." }, "signatureRequired" : { "type" : "boolean", "description" : "Specifies whether a signature is required for delivery. Default is False." }, "shippingInstructions" : { "type" : "string", "maxLength" : 132 } } }, "additionalAttributes" : { "type" : "array", "description" : "Shipment-level additional attributes.", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "**allowPartialOrder:** Allow orders with failed lines. \n\n\n**DpasRating:** DX rating by Department of Defense is the highest rating by the highest offices and meant to be top priority. DO any other gov offices at the federal level to priotize. \n\n **DpasProgramId:** Identifies the actual agency that signed off on the DPAS priority. \n\n **allowDuplicateCustomerOrderNumber:** Allow orders with duplicate customer PO numbers. Enables resellers to have the same PO number for multiple orders. \n \n **euDepId:** DEP ID would be the 'End User DEP/ABM Organization ID' up to 32 characters and is assigned by Apple.\n \n **depOrderNbr:** depOrderNbr is reseller’s own DEP ID assigned by Apple.\n \n **govtProgramType:** Program type, “PA” for government orders, “ED” for education order.\n \n **govtEndUserType:** Type of end user of the program. F = Federal, S = State, E = Local, K = K-12 school, and H = Higher Education\n \n **govtSolicitationNumber:** Education order’s contract number\n \n **govtPublicPrivateCode:** Determines TAX / NO TAX. 'P' PUBLIC SECTOR, 'R' PRIVATE SECTOR. Value needs only to be provided for EDUCATION order.\n \n **govtEndUserData:** Name of the End user of the program. For example, STATE OF OHIO, CHICAGO SCHOOLDISTRICT etc.\n \n **govtEndUserPostalCode:** 9 CHAR FIELD / Zip Code of the End user of the order.\n \n **dynamicMessageLine1:** Custom Dynamic Message line 1.\n \n **allowOrderOnCustomerHold:** Boolean value flag which allows a customer to create an order with the hold status." }, "attributeValue" : { "type" : "string", "description" : "attributefield data" } } } } } }, "OrderCreateResponse" : { "type" : "object", "properties" : { "customerOrderNumber" : { "type" : "string", "description" : "The reseller's unique PO/Order number." }, "endCustomerOrderNumber" : { "type" : "string", "maxLength": 18, "description" : "The end user/customer's Purchase Order number." }, "billToAddressId" : { "type" : "string", "description" : "Suffix used to identify billing address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit" }, "specialBidNumber" : { "type" : "string", "description" : "The bid number provided to the reseller by the vendor for special pricing and discounts. Line-level bid numbers take precedence over header-level bid numbers." }, "orderSplit" : { "type" : "boolean", "description" : "true for multiple orders" }, "processedPartially" : { "type" : "boolean", "description" : "true for partial order succesfully placed" }, "purchaseOrderTotal" : { "type" : "number", "format" : "decimal", "description" : "Total of all the orders including taxes and fees." }, "shipToInfo" : { "type" : "object", "description" : "The shipping information provided by the reseller.", "properties" : { "addressId" : { "type" : "string", "description" : "The ID references the resellers address in Ingram Micro's system for shipping. Provided to resellers during the onboarding process." }, "contact" : { "type" : "string", "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "description" : "The reseller's company name or the End-User's Name" }, "addressLine1" : { "type" : "string", "description" : "The street address and building or house number the order will be shipped to." }, "addressLine2" : { "type" : "string", "description" : "The apartment number the order will be shipped to." }, "city" : { "type" : "string", "description" : "The city the order will be shipped to." }, "state" : { "type" : "string", "description" : "The state the order will be shipped to." }, "postalCode" : { "type" : "string", "description" : "The zip or postal code the order will be shipped to." }, "countryCode" : { "type" : "string", "description" : "The two-character ISO country code the order will be shipped to." }, "phoneNumber" : { "type" : "string", "description" : "The company contact phone number." }, "email" : { "type" : "string", "description" : "The company contact email address." } } }, "endUserInfo" : { "type" : "object", "description" : "The contact information for the end user/customer provided by the reseller. Used to determine pricing and discounts.", "properties" : { "endUserId" : { "type" : "string", "description" : "The unique ID provided by the reseller for the end user/customer." }, "contact" : { "type" : "string", "description" : "The contact name for the end user/customer." }, "companyName" : { "type" : "string", "description" : "The company name for the end user/customer." }, "addressLine1" : { "type" : "string", "description" : "The street adress and building or house number for the end user/customer." }, "addressLine2" : { "type" : "string", "description" : "The apartment number for the end user/customer." }, "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", "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." } } }, "orders" : { "type" : "array", "description" : "Order-level details.", "items" : { "type" : "object", "properties" : { "numberOfLinesWithSuccess" : { "type" : "integer", "description" : "The number of lines in the order that were successful." }, "numberOfLinesWithError" : { "type" : "integer", "description" : "The number of lines in the order that have errors." }, "numberOfLinesWithWarning" : { "type" : "integer", "description" : "The number of lines in the order that have a warning." }, "ingramOrderNumber" : { "type" : "string", "description" : "The Ingram Micro order number." }, "ingramOrderDate" : { "type" : "string", "description" : "The date in UTC format that the order was created in Ingram Micro's system." }, "notes" : { "type" : "string", "description" : "Order-level notes." }, "orderType" : { "type" : "string", "description" : "The order typer. One of: S=Stocked PO D=Direct Ship PO" }, "orderTotal" : { "type" : "number", "format" : "decimal", "description" : "The total price for the order." }, "freightCharges" : { "type" : "number", "format" : "decimal", "description" : "The total freight charges for the order." }, "totalTax" : { "type" : "number", "format" : "decimal", "description" : "The total tax for the order." }, "currencyCode" : { "type" : "string", "description" : "The country-specific three character ISO 4217 currency code used for the order." }, "lines" : { "type" : "array", "description" : "The line-level details for the order.", "items" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "ingramLineNumber" : { "type" : "string", "description" : "The Ingram Micro line number for the product." }, "customerLineNumber" : { "type" : "string", "description" : "The reseller's line number for reference in their system." }, "lineStatus" : { "type" : "string", "description" : "The status for the line item in the order. One of: Backordered, Open" }, "ingramPartNumber" : { "type" : "string", "maxLength": 6, "description" : "The Ingram Micro part number for the line item." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor part number for the line item." }, "unitPrice" : { "type" : "number", "format" : "decimal", "description" : "The unit price for the line item." }, "extendedUnitPrice" : { "type" : "number", "format" : "decimal", "description" : "The extended list price (unit price X quantity) for the line item." }, "quantityOrdered" : { "type" : "integer", "description" : "The quantity of the line item ordered." }, "quantityConfirmed" : { "type" : "integer", "description" : "The quantity of the line item that has been confirmed." }, "quantityBackOrdered" : { "type" : "integer", "description" : "The quantity of the line item that is backordered." }, "specialBidNumber" : { "type" : "string", "description" : "The bid number for the line item provided to the reseller by the vendor for special pricing and discounts. Line-level bid numbers take precedence over header-level bid numbers." }, "notes" : { "type" : "string", "description" : "Line-level notes." }, "shipmentDetails" : { "type" : "array", "description" : "The shipment details for the line item.", "items" : { "type" : "object", "properties" : { "carrierCode" : { "type" : "string", "description" : "The code for the shipping carrier for the line item." }, "carrierName" : { "type" : "string", "description" : "The name of the shipping carrier for the line item." }, "shipFromWarehouseId" : { "type" : "string", "description" : "The ID of the warehouse the line item will ship from." }, "shipFromLocation" : { "type" : "string", "description" : "Location from which order is shipped." }, "freightAccountNumber" : { "type" : "string", "description" : "The reseller's shipping account number with carrier. Used to bill the shipping carrier directly from the reseller's account with the carrier." }, "signatureRequired" : { "type" : "string", "description" : "Specifies whether a signature is required for delivery. Default is False." }, "shippingInstructions" : { "type" : "string", "description" : "The shipping instructions for the order." } } } }, "additionalAttributes" : { "type" : "array", "description" : "SAP requested and country-specific line level details.", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string" }, "attributeValue" : { "type" : "string" } } } } } } }, "miscellaneousCharges" : { "type" : "array", "items" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "chargeLineReference" : { "type" : "string", "description" : "Impulse line number for the miscellaneous charge." }, "chargeDescription" : { "type" : "string", "description" : "Description of the miscellaneous charges for the order." }, "chargeAmount" : { "type" : "number", "format" : "decimal", "description" : "The total amount of miscellaneous charges for the order." } } } }, "links" : { "type" : "array", "description" : "Link to Order Details for the order(s).", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the orders." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link (GET, POST, Etc.)." } } } }, "rejectedLineItems" : { "type" : "array", "description" : "A list of rejected line items.", "items" : { "type" : "object", "properties" : { "customerLinenumber" : { "type" : "string", "description" : "The reseller's line item number of the rejected item for their reference. Number" }, "ingramPartNumber" : { "type" : "string", "description" : "The Ingram Micro part number for the rejected line item." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor part number for the rejected line item." }, "quantityOrdered" : { "type" : "integer", "description" : "The quantity ordered of the rejected line item." }, "rejectCode" : { "type" : "string", "description" : "The rejection code for the rejected line item. Ex: 'EN' " }, "rejectReason" : { "type" : "string", "description" : "The rejection reason for the rejected line item. Ex: 'SKU-NOTFOUND DF41281' " } } } }, "additionalAttributes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : " allowPartialOrder: Allow orders with failed lines. (SAP) Depends on backorder settings.\n\n\ndpasRating: DX rating by Department of Defense is the highest rating by the highest offices and meant to be top priority. DO any other gov offices at the federal level to priotize.\n\n\ndpasProgramId: Identifies the actual agency that signed off on the DPAS priority. \n\nstorageLocation: Determine the location of the product stock in SAP for Marketplaces.\n\nsoldTo: To be used in cases when Sold-To is different than Customer ID.\n\neuDepId: DEP ID would be the 'End User DEP/ABM Organization ID' up to 32 characters and is assigned by Apple.\n\ndepOrderNbr: depOrderNbr is reseller’s own DEP ID assigned by Apple.\n " }, "attributeValue" : { "type" : "string", "description" : "Attribute value" } } } } } } } } }, "OrderModifyRequest" : { "type" : "object", "properties" : { "notes" : { "type" : "string", "description" : "Shipment-level notes.", "maxLength" : 132 }, "shipToInfo" : { "type" : "object", "description" : "The shipping information provided by the reseller.", "properties" : { "addressId" : { "type" : "string", "maxLength" : 10, "description" : "Suffix used to identify billing address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit." }, "contact" : { "type" : "string", "maxLength" : 40, "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "maxLength" : 40, "description" : "The reseller's company name or the End-User's Name" }, "addressLine1" : { "type" : "string", "maxLength" : 60, "description" : "The street address and building or house number the order will be shipped to." }, "addressLine2" : { "type" : "string", "maxLength" : 40, "description" : "The apartment number the order will be shipped to." }, "city" : { "type" : "string", "maxLength" : 25, "description" : "The city the order will be shipped to." }, "state" : { "type" : "string", "maxLength" : 3, "description" : "The state the order will be shipped to." }, "postalCode" : { "type" : "string", "maxLength" : 10, "description" : "The zip or postal code the order will be shipped to." }, "countryCode" : { "type" : "string", "maxLength" : 3, "description" : "The two-character ISO country code the order will be shipped to." }, "phoneNumber" : { "type" : "string", "maxLength" : 30, "description" : "The company contact phone number." }, "email" : { "type" : "string", "maxLength" : 241, "description" : "The company contact email address." } } }, "lines" : { "type" : "array", "description" : "The order line items.", "items" : { "type" : "object", "properties" : { "ingramPartNumber" : { "type" : "string", "maxLength" : 18, "description" : "The unique IngramMicro part number." }, "ingramLineNumber" : { "type" : "string", "maxLength" : 6, "description" : "The IngramMicro line number." }, "customerLineNumber" : { "type" : "string", "maxLength" : 6, "description" : "The reseller's line number for reference in their system." }, "addUpdateDeleteLine" : { "type" : "string", "description" : "The line number that was added, updated, or deleted.", "enum" : [ "UPDATE", "DELETE", "ADD" ] }, "quantity" : { "type" : "integer", "description" : "The quantity of the line item." }, "notes" : { "type" : "string", "maxLength" : 132, "description" : "The line-level notes." } } } }, "additionalAttributes" : { "type" : "array", "description" : "Header-level additional attributes.", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "Example values are 'entryMethod', 'enableCommentsAsLines', 'regionCode'" }, "attributeValue" : { "type" : "string", "description" : "Attribute Value" } } } } } }, "OrderModifyResponse" : { "type" : "object", "properties" : { "ingramOrderNumber" : { "type" : "string", "description" : "The IngramMicro order number." }, "changeDescription" : { "type" : "string", "description" : "The description of the change." }, "orderModifiedDate" : { "type" : "string", "description" : "The date the order was modified." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's order number for reference in their system." }, "endCustomerOrderNumber" : { "type" : "string", "description" : "The end user/customer's order number for reference in their system." }, "orderTotal" : { "type" : "number", "format" : "decimal", "description" : "The total for the order." }, "notes" : { "type" : "string", "description" : "Order-level notes." }, "orderSubTotal" : { "type" : "number", "format" : "decimal", "description" : "The sub total for the order." }, "freightCharges" : { "type" : "number", "format" : "decimal", "description" : "The freight charges for the order." }, "totalTax" : { "type" : "number", "format" : "decimal", "description" : "The total tax for the order." }, "orderStatus" : { "type" : "string", "description" : "The status of the order. One of the following. Backordered, In Progress, Shipped, Delivered, Canceled, On Hold" }, "billToAddressId" : { "type" : "string", "description" : "Suffix used to identify billing address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit." }, "shipToInfo" : { "type" : "object", "description" : "The shipping information for the order provided by the reseller.", "properties" : { "addressId" : { "type" : "string", "description" : "Suffix used to identify shipping address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit." }, "contact" : { "type" : "string", "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "description" : "The reseller's company name or the End-User's Name" }, "addressLine1" : { "type" : "string", "description" : "The street address and building or house number the order will be shipped to." }, "addressLine2" : { "type" : "string", "description" : "The apartment number the order will be shipped to." }, "city" : { "type" : "string", "description" : "The city the order will be shipped to." }, "state" : { "type" : "string", "description" : "The state the order will be shipped to." }, "postalCode" : { "type" : "string", "description" : "The zip or postal code the order will be shipped to." }, "countryCode" : { "type" : "string", "description" : "The two-character ISO country code the order will be shipped to." }, "phoneNumber" : { "type" : "string", "description" : "The company contact phone number." }, "email" : { "type" : "string", "description" : "The company contact email address." } } }, "lines" : { "type" : "array", "description" : "The line-level details for the order.", "items" : { "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "ingramLineNumber" : { "type" : "string", "description" : "The IngramMicro line number." }, "customerLineNumber" : { "type" : "string", "description" : "The reseller's line number for reference in their system." }, "ingramPartNumber" : { "type" : "string", "maxLength": 6, "description" : "The unique IngramMicro part number for the line item." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor's part number for the line item." }, "quantityOrdered" : { "type" : "integer", "description" : "The quantity ordered of the line item." }, "quantityConfirmed" : { "type" : "integer", "description" : "The quantity confirmed of the line item." }, "quantityBackOrdered" : { "type" : "integer", "description" : "The quantity backordered of the line item." }, "shipmentDetails" : { "type" : "object", "description" : "Shipping details for the order provided by the reseller.", "properties" : { "carrierCode" : { "type" : "string", "description" : "The carrier code for the shipment containing the line item." }, "carrierName" : { "type" : "string", "description" : "The name of the carrier of the shipment containing the line item." }, "freightAccountNumber" : { "type" : "string", "description" : "The reseller's shipping account number with carrier. Used to bill the shipping carrier directly from the reseller's account with the carrier." } } }, "additionalAttributes" : { "type" : "array", "description" : "SAP requested and country-specific line level details.", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "Attribute Name." }, "attributeValue" : { "type" : "string", "description" : "Attribute Value." } } } }, "notes" : { "type" : "string", "description" : "Line-level notes for the order." } } } }, "rejectedLineItems" : { "type" : "array", "description" : "Details for failed lines in the order.", "items" : { "properties" : { "ingramLineNumber" : { "type" : "string", "description" : "The IngramMicro line number for the failed line item." }, "customerLineNumber" : { "type" : "string", "description" : "The reseller's line number of the failed line item for reference in their system." }, "ingramPartNumber" : { "type" : "string", "description" : "The IngramMicro part number for the failed line item." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor's part number for the failed line item." }, "quantityOrdered" : { "type" : "integer", "description" : "The quantity ordered of the failed line item." }, "rejectCode" : { "type" : "string", "description" : "The rejection code for the failed line item." }, "rejectReason" : { "type" : "string", "description" : "The rejection reason for the failed line item." } } } }, "additionalAttributes" : { "type" : "array", "description" : "Header-level additional attributes.", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "Attribute Name." }, "attributeValue" : { "type" : "string", "description" : "Attribute Value." } } } } } }, "OrderDetailResponse" : { "type" : "object", "x-tags" : [ "Orders" ], "properties" : { "ingramOrderNumber" : { "type" : "string", "description" : "The IngramMicro sales order number." }, "ingramOrderDate" : { "type" : "string", "description" : "The date and time in UTC format that the order was created." }, "orderType" : { "type" : "string", "description" : "The order type. One of B = Branch Transfer, C = COD, D = Direct Ship, F = Future Order, P = Special Order, M = Memo, Q = Quote, S = Sales Order." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's order number for reference in their system." }, "endCustomerOrderNumber" : { "type" : "string", "description" : "The end user/customer's order number for reference in their system." }, "vendorSalesOrderNumber" : { "type" : "string", "description" : "The vendor's order number for reference in their system." }, "orderStatus" : { "type" : "string", "description" : "The header-level status of the order. One of- Shipped, Canceled, Backordered, Processing, On Hold, Delivered." }, "orderTotal" : { "type" : "number", "format" : "decimal", "description" : "The total cost for the order, includes subtotal, freight charges, and tax." }, "orderSubTotal" : { "type" : "number", "format" : "decimal", "description" : "The sub total cost for the order, not including tax and freight." }, "freightCharges" : { "type" : "number", "format" : "decimal", "description" : "The freight charges for the order." }, "currencyCode" : { "type" : "string", "description" : "The country-specific three digit ISO 4217 currency code for the order." }, "totalWeight" : { "type" : "number", "format" : "decimal", "description" : "The total weight of the order. Pounds in North America, KG in all other countries." }, "totalTax" : { "type" : "number", "format" : "decimal", "description" : "The total tax for the order." }, "paymentTerms" : { "type" : "string", "description" : "The payment terms of the order. (Ex- Net 30 days)." }, "notes" : { "type" : "string", "description" : "The header-level notes for the order." }, "billToInfo" : { "type" : "object", "description" : "The billing information provided by the reseller.", "properties" : { "contact" : { "type" : "string", "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "description" : "The name of the company the order will be billed to." }, "addressLine1" : { "type" : "string", "description" : "The street address and building or house number the order will be billed to." }, "addressLine2" : { "type" : "string", "description" : "The apartment number the order will be billed to." }, "city" : { "type" : "string", "description" : "The city the order will be billed to." }, "state" : { "type" : "string", "description" : "The state the order will be billed to." }, "postalCode" : { "type" : "string", "description" : "The zip or postal code the order will be billed to." }, "countryCode" : { "type" : "string", "description" : "The two-character ISO country code the order will be billed to." }, "phoneNumber" : { "type" : "string", "description" : "The company contact phone number." }, "email" : { "type" : "string", "description" : "The company contact email address." } } }, "shipToInfo" : { "type" : "object", "description" : "The shipping information provided by the reseller for order delivery.", "properties" : { "contact" : { "type" : "string", "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "description" : "The reseller's company name or the End-User's Name" }, "addressLine1" : { "type" : "string", "description" : "The street address the order will be shipped to." }, "addressLine2" : { "type" : "string", "description" : "The building or apartment number the order will be shipped to." }, "city" : { "type" : "string", "description" : "The city the order will be shipped to." }, "state" : { "type" : "string", "description" : "The state the order will be shipped to." }, "postalCode" : { "type" : "string", "description" : "The zip or postal code the order will be shipped to." }, "countryCode" : { "type" : "string", "description" : "The two-character ISO country code the order will be shipped to." }, "phoneNumber" : { "type" : "string", "description" : "The company contact phone number." }, "email" : { "type" : "string", "description" : "The company contact email address." } } }, "endUserInfo" : { "type" : "object", "description" : "The contact information for the end user/customer provided by the reseller. Used to determine pricing and discounts.", "properties" : { "contact" : { "type" : "string", "description" : "The contact name for the end user/customer." }, "companyName" : { "type" : "string", "description" : "The company name for the end user/customer." }, "addressLine1" : { "type" : "string", "description" : "The street adress and building or house number for the end user/customer." }, "addressLine2" : { "type" : "string", "description" : "The apartment number for the end user/customer." }, "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", "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", "items" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "ingramOrderLineNumber" : { "type" : "string", "description" : "Unique Ingram Micro line number. Starts with 001." }, "vendorSalesOrderLineNumber" : { "type" : "string", "description" : "The vendor's sales order line number." }, "customerLinenumber" : { "type" : "string", "description" : "The reseller's line item number for reference in their system." }, "lineStatus" : { "type" : "string", "description" : "The status for the line item in the order. One of- Backordered, In Progress, Shipped, Delivered, Canceled, On Hold" }, "ingramPartNumber" : { "type" : "string", "description" : "Unique IngramMicro part number." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor's part number for the line item." }, "vendorName" : { "type" : "string", "description" : "The vendor's name for the part in their system." }, "partDescription" : { "type" : "string", "description" : "The vendor's description of the part in their system." }, "unitWeight" : { "type" : "number", "format" : "decimal", "description" : "The unit weight of the line item." }, "weightUom" : { "type" : "string", "description" : "The unit of measure for the line item." }, "unitPrice" : { "type" : "integer", "description" : "The unit price of the line item." }, "upcCode" : { "type" : "string", "description" : "The UPC code of a product." }, "extendedPrice" : { "type" : "number", "format" : "decimal", "description" : "Unit price X quantity for the line item." }, "taxAmount" : { "type" : "number", "format" : "decimal", "description" : "The tax amount for the line item." }, "currencyCode" : { "type" : "string", "description" : "The country-specific three character ISO 4217 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." }, "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 in the case of split orders or where different line items have different bid numbers. Line-level bid numbers take precedence over header-level bid numbers." }, "requestedDeliveryDate" : { "type" : "string", "format" : "date", "description" : "Reseller-requested delivery date. Delivery date is not guaranteed." }, "promisedDeliveryDate" : { "type" : "string", "format" : "date", "description" : "The delivery date promised by IngramMicro." }, "lineNotes" : { "type" : "string", "description" : "Line-level notes for the order." }, "shipmentDetails" : { "type" : "array", "items" : { "type" : "object", "description" : "Shipping details for the line item.", "properties" : { "quantity" : { "type" : "integer", "description" : "The quantity shipped of the line item." }, "estimatedShipDate" : { "type" : "string", "format" : "date", "description" : "The estimated ship date for the line item." }, "shippedDate" : { "type" : "string", "format" : "date", "description" : "The date the line item was shipped." }, "estimatedDeliveryDate" : { "type" : "string", "format" : "date", "description" : "The date the line item is expected to be delivered." }, "deliveredDate" : { "type" : "string", "format" : "date", "description" : "The actual date of delivery of the line item." }, "shipFromWarehouseId" : { "type" : "string", "description" : "The ID of the warehouse the product will ship from." }, "shipFromLocation" : { "type" : "string", "description" : "The city and state the line item ships from." }, "invoiceNumber" : { "type" : "string", "description" : "The Ingram Micro invoice number for the line item." }, "invoiceDate" : { "type" : "string", "format" : "date", "description" : "The date the IngramMicro invoice was created for the line item." }, "carrierDetails" : { "type" : "object", "description" : "The shipment carrier details for the line item.", "properties" : { "carrierCode" : { "type" : "string", "description" : "The carrier code for the shipment containing the line item." }, "carrierName" : { "type" : "string", "description" : "The name of the carrier of the shipment containing the line item." }, "trackingDetails" : { "type" : "array", "items" : { "type" : "object", "description" : "The tracking details for the shipment containing the line item.", "properties" : { "trackingNumber" : { "type" : "string", "description" : "The tracking number for the shipment containing the line item." }, "trackingUrl" : { "type" : "string", "description" : "The tracking URL for the shipment containing the line item." }, "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." }, "quantityInBox" : { "type" : "string", "description" : "The quantity of line items in the box." }, "SerialNumbers" : { "type" : "array", "items" : { "type" : "object", "description" : "A list of serial numbers of the line items contained in the shipment.", "properties" : { "serialNumber" : { "type" : "string", "description" : "The serial number for the line item." } } } } } } } } } } } }, "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." } } } }, "links" : { "type" : "array", "items" : { "type" : "object", "description" : "Link to Order Details for the line item.", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the line item." }, "href" : { "type" : "string", "description" : "The API endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link(GET,POST etc)." } } } } } } }, "miscellaneousCharges" : { "type" : "array", "items" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "chargeLineReference" : { "type" : "string", "description" : "Impulse line number for the miscellaneous charge." }, "chargeDescription" : { "type" : "string", "description" : "Description of the miscellaneous charges." }, "chargeAmount" : { "type" : "number", "format" : "double", "description" : "The amount of miscellaneous charges." } } } }, "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." } } } } } }, "OrderSearch_Response" : { "type" : "object", "properties" : { "recordsFound" : { "type" : "integer", "description" : "No of recourds found for the search." }, "pageSize" : { "type" : "integer", "description" : "No of results per page.(default is 25)" }, "pageNumber" : { "type" : "integer", "description" : "Current page number.(default is 1)" }, "orders" : { "type" : "array", "description" : "The details for the order.", "items" : { "type" : "object", "properties" : { "ingramOrderNumber" : { "type" : "string", "description" : "The Ingram Micro order number." }, "ingramOrderDate" : { "type" : "string", "description" : "The date the order was created(UTC)." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's order number for reference in their system." }, "vendorSalesOrderNumber" : { "type" : "string", "description" : "The vendor's order number.(only for D-Type Orders)" }, "vendorName" : { "type" : "string", "description" : "The name of the vendor." }, "endUserCompanyName" : { "type" : "string", "description" : "The company name of the end user/customer." }, "orderTotal" : { "type" : "number", "format" : "decimal", "description" : "The total of the order." }, "orderStatus" : { "type" : "string", "description" : "The header-level status of the order.(OPEN/CLOSED/CANCELLED)" }, "subOrders" : { "type" : "array", "description" : "Individual Ingram Micro order numbers associated with a single reseller PO.", "items" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest to the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "subOrderTotal" : { "type" : "number", "format" : "decimal", "description" : "The total for the suborder." }, "subOrderStatus" : { "type" : "string", "description" : "The status of the suborder. One of:- Shipped, Canceled, Backordered, Processing, On Hold, Delivered" }, "links" : { "type" : "array", "description" : "Link to Order Details for the sub order(s).", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "For orders or invoices. For orders the link provides details of the order. For invoices the link provides details of the invoice." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link (GET, POST, Etc.)." } } } } } } }, "links" : { "type" : "object", "description" : "Link to Order Details for the order(s).", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the orders." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link (GET, POST, Etc.)." } } } } } }, "nextPage" : { "type" : "string", "description" : "link/URL for accessing next page." }, "previousPage" : { "type" : "string", "description" : "link/URL for accessing previous page." } } }, "PriceAndAvailabilityRequest" : { "type" : "object", "properties" : { "showAvailableDiscounts" : { "type" : "boolean", "description" : "Boolean value that will display Discount details in the response when true." }, "showReserveInventoryDetails" : { "type" : "boolean", "description" : "Boolean value that will display reserve inventory details in the response when true." }, "specialBidNumber" : { "type" : "string", "description" : "Pre-approved special pricing/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." }, "availabilityByWarehouse" : { "type" : "array", "items" : { "type" : "object", "properties" : { "availabilityByWarehouseId" : { "type" : "string", "description" : "Plant/warehouse Id of a particular location in order to get just the inventory of that location." }, "availabilityForAllLocation" : { "type" : "boolean", "description" : "Pass boolean value as input, if true the response will contain warehouse location details, if false the response will not hold warehouse location details. By default value is true." } } } }, "products" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ingramPartNumber" : { "type" : "string", "description" : "Ingram Micro unique part number for the product." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor’s part number for the product. It can be either TS Product or Cloud Product vendorpartnumber." }, "customerPartNumber" : { "type" : "string", "description" : "Reseller/end-user’s part number for the product." }, "upc" : { "type" : "string", "description" : "The UPC code for the product. Consists of 12 numeric digits that are uniquely assigned to each trade item." }, "quantityRequested" : { "type" : "string", "description" : "Number of quantity of the Product." }, "planID" : { "type" : "string", "description" : "Id of the plan." }, "additionalAttributes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "shipfrombranchnumber: If provided, displays only the availability of the specified branch number.
governmentprogramcode: Special Discount details will be provided based on the governmentprogramcode if available. The available codes are… \n\n* PAF for Federal Gov discount. \n\n* PAS for State Gov discount. \n\n* PAE for Local Gov discount. \n\n* EDK for Lower education discount. \n\n* EDH for Higher Education discount" }, "attributeValue" : { "type" : "string", "description" : "key value pair -key value." } } } } } } }, "additionalAttributes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "key value pair -key Name." }, "attributeValue" : { "type" : "string", "description" : "key value pair -key value." } } } } } }, "PriceAndAvailabilityResponse" : { "type" : "array", "items" : { "type" : "object", "properties" : { "productStatusCode" : { "type" : "string", "description" : "Codes signifying whether the sku is active or not." }, "productStatusMessage" : { "type" : "string", "description" : "Message returned saying whether sku is active." }, "ingramPartNumber" : { "type" : "string", "description" : "Ingram Micro unique part number for the product." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor’s part number for the product." }, "extendedVendorPartNumber" : { "type" : "string", "description" : "Extended Vendor Part Number. *Currently, this feature is not available in these countries (Mexico, Turkey, New Zealand, Colombia, Chile, Brazil, Peru, Western Sahara)." }, "customerPartNumber" : { "type" : "string", "description" : "Reseller / end-user’s part number for the product." }, "upc" : { "type" : "string", "description" : "The UPC code for the product. Consists of 12 numeric digits that are uniquely assigned to each trade item." }, "partNumberType" : { "type" : "string", "description" : "Number type of the part." }, "vendorNumber" : { "type" : "string", "description" : "Vendor number that identifies the product." }, "vendorName" : { "type" : "string", "description" : "Vendor name for the order." }, "description" : { "type" : "string", "description" : "The description given for the product." }, "productClass" : { "type" : "string", "description" : "Indicates whether the product is directly shipped from the vendor’s warehouse or if the product ships from Ingram Micro’s warehouse. Class Codes are Ingram classifications on how skus are stocked\nA = Product that is stocked usually in all IM warehouses and replenished on a regular basis.\nB = Product that is stocked in limited IM warehouses and replenished on a regular basis\nC = Product that is stocked in fewer IM warehouses and replenished on a regular basis.\nD = Product that Ingram Micro has elected to discontinue.\nE = Product that will be phased out later, according to the vendor. You may not want to replenish this product, but instead sell down what is in stock.\nF = Product that we carry for a specific customer or supplier under a contractual agreement.\nN = New Sku. Classification before first receipt\nO = Discontinued product to be liquidated\nS= Order for Specialized Demand (Order to backorder)\nX= direct ship from Vendor\nV = product that vendor has elected to discontinue." }, "uom" : { "type" : "string", "description" : "The description given for the product." }, "productStatus" : { "type" : "string", "description" : "Status that gives whether the product is Active." }, "acceptBackOrder" : { "type" : "boolean", "description" : "Boolean that indicates if the product accepts backorder." }, "productAuthorized" : { "type" : "boolean", "description" : "Boolean that indicates whether a product is authorized." }, "returnableProduct" : { "type" : "boolean", "description" : "Boolean that indicates if the product can be returned." }, "endUserInfoRequired" : { "type" : "boolean", "description" : "Boolean that indicates if end user information is required." }, "govtSpecialPriceAvailable" : { "type" : "boolean", "description" : "Boolean that indicates if special pricing is available for the product." }, "govtProgramType" : { "type" : "string", "description" : "Program type, “PA” for government orders, “ED” for education order." }, "govtEndUserType" : { "type" : "string", "description" : "Type of end user of the program. F = Federal, S = State, E = Local, K = K-12 school, and H = Higher Education." }, "availability" : { "type" : "object", "properties" : { "available" : { "type" : "boolean", "description" : "Boolean that indicates if the product ordered is available" }, "totalAvailability" : { "type" : "integer", "description" : "The total amount of available products" }, "availabilityByWarehouse" : { "type" : "array", "items" : { "type" : "object", "properties" : { "location" : { "type" : "string", "description" : "Indicates where (location) the product is available." }, "warehouseId" : { "type" : "string", "description" : "Indicates where (Ingram Warehouse Id) the product is available." }, "quantityAvailable" : { "type" : "integer", "description" : "The quantity of the product available in a given warehouse." }, "quantityBackordered" : { "type" : "integer", "description" : "The quantity of a product backordered in a given warehouse." }, "quantityBackorderedEta" : { "type" : "string", "description" : "The estimated time of arrival of a product that has been backordered in a given warehouse." }, "backOrderInfo" : { "type" : "array", "description" : "*Currently, this feature is not available in these countries (Mexico, Turkey, New Zealand, Colombia, Chile, Brazil, Peru, Western Sahara).", "items" : { "type" : "object", "properties" : { "quantity" : { "type" : "integer", "description" : "Quantity backordered." }, "etaDate" : { "type" : "string", "description" : "Expected availability date.", "format" : "Date" } } } } } } } } }, "reserveInventoryDetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "quantityReserved" : { "type" : "integer", "description" : "The quantity of the product reserved for the customer." }, "quantityAvailable" : { "type" : "integer", "description" : "The availability of the product reserved." }, "effectivedate" : { "type" : "string", "description" : "The reservation date for the product in UTC format.", "format" : "Date" }, "expirydate" : { "type" : "string", "description" : "The expiration date for the reservation of the product in UTC format.", "format" : "Date" } } } }, "pricing" : { "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The 3-digit ISO currency code." }, "retailPrice" : { "type" : "number", "format" : "decimal", "description" : "The retail price of the product." }, "mapPrice" : { "type" : "number", "format" : "decimal", "description" : "Minimum Advertised Price (MAP). If required by the vendor, resellers can not sell below MAP price." }, "customerPrice" : { "type" : "number", "format" : "decimal", "description" : "The price customer pays after all special pricing and discounts have been applied." }, "specialBidPricingAvailable" : { "type" : "boolean", "description" : "Boolean values specifies whether special Bid discounts are available for the product." }, "webDiscountsAvailable" : { "type" : "boolean", "description" : "Boolean values specifies whether web Discounts are available for the product." } } }, "discounts" : { "type" : "array", "items" : { "type" : "object", "properties" : { "specialPricing" : { "type" : "array", "items" : { "type" : "object", "properties" : { "discountType" : { "type" : "string", "description" : "The type of discount being given to the customer.", "example" : "Special Bid, Promo Discount" }, "specialBidNumer" : { "type" : "string", "description" : "Pre-approved special pricing/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." }, "specialPricingDiscount" : { "type" : "number", "format" : "decimal", "description" : "Special pricing discount amount given to the customer." }, "specialPricingEffectiveDate" : { "type" : "string", "format" : "date", "description" : "The effective date of the special pricing available to the customer." }, "specialPricingExpirationDate" : { "type" : "string", "format" : "date", "description" : "The expiration date of the special pricing available to the customer." }, "specialPricingAvailableQuantity" : { "type" : "integer", "description" : "The available quantity of products with discounts." }, "specialPricingMinQuantity" : { "type" : "integer", "description" : "The minimum quantity of products that have to be purchased to ensure the discount is applied." }, "governmentDiscountType" : { "type" : "string", "description" : "Type of Government Discount. *Currently, this discount is only available in the USA." }, "governmentDiscountedCustomerPrice" : { "type" : "number", "format" : "decimal", "description" : "Government Discounted Customer Price. *Currently, this discount is only available in the USA." } } } }, "quantityDiscounts" : { "type" : "array", "items" : { "type" : "object", "properties" : { "conditionType" : { "type" : "string", "description" : "Indicates when the discount is applied after ordering the product.", "example" : "Total fee" }, "currencyCode" : { "type" : "string", "description" : "The country-specific three digit ISO 4217 currency code for the order." }, "currencyType" : { "type" : "string", "description" : "Type of currency." }, "quantity" : { "type" : "integer", "description" : "The total discounted quantity of the product." }, "amount" : { "type" : "number", "format" : "decimal", "description" : "The total price of all the discounts applied." } } } } } } }, "bundlePartIndicator" : { "type" : "boolean", "description" : "True of false value to indicate whether it’s bundle part. *Currently, this feature is not available in these countries (Mexico, Turkey, New Zealand, Colombia, Chile, Brazil, Peru, Western Sahara)." }, "serviceFees" : { "type" : "array", "description" : "*Currently, this feature is not available in these countries (Mexico, Turkey, New Zealand, Colombia, Chile, Brazil, Peru, Western Sahara).", "items" : { "type" : "object", "properties" : { "conditionType" : { "type" : "string", "description" : "Condition Type of the service fees." }, "description" : { "type" : "string", "description" : "Description of the service fees." }, "amount" : { "type" : "number", "format" : "decimal", "description" : "Amount of the service fees." }, "endDate" : { "type" : "string", "description" : "End Date of the service fees." }, "currencyCode" : { "type" : "string", "description" : "Currency Code of the service fees." } } } }, "subscriptionPrice" : { "type" : "array", "items" : { "type" : "object", "properties" : { "planId" : { "type" : "string", "description" : "Id of the plan." }, "planName" : { "type" : "string", "description" : "Name of the plan." }, "planDescription" : { "type" : "number", "description" : "The description of the plan." }, "groups" : { "type" : "array", "items" : { "type" : "object", "properties" : { "groupName" : { "type" : "string", "description" : "The name of the group" }, "groupDescription" : { "type" : "string", "description" : "The description of the group." } } } }, "billingPeriod" : { "type" : "array", "items" : { "type" : "object", "properties" : { "billingPeriodUnit" : { "type" : "string", "description" : "The unit of the billing period." }, "billingPeriod" : { "type" : "string", "description" : "The billing period value." } } } }, "subscriptionPeriod" : { "type" : "array", "items" : { "type" : "object", "properties" : { "subscriptionPeriodUnit" : { "type" : "string", "description" : "The unit of the subscription period." }, "subscriptionPeriod" : { "type" : "string", "description" : "The subscription period value." } } } }, "options" : { "type" : "array", "items" : { "type" : "object", "properties" : { "resourceId" : { "type" : "string", "description" : "The resource id of the subscription product." }, "resourceName" : { "type" : "string", "description" : "The name of the resource of the subscription product." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor’s part number for the subscription product." }, "minUnits" : { "type" : "string", "description" : "Minimum unit needs to purchased." }, "maxUnits" : { "type" : "string", "description" : "Maximum unit available for a purchase." }, "recurringpricemodel" : { "type" : "string", "description" : "Recurring price model" }, "unitOfMeasure" : { "type" : "string", "description" : "Unit of mesaure for a subscription product." }, "resourcePricing" : { "type" : "array", "items" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the type of pricing." }, "quantity" : { "type" : "integer", "description" : "Quantity of the line item." }, "msrp" : { "type" : "decimal", "description" : "Manufacturer Suggested Retail Price." }, "unitPrice" : { "type" : "decimal", "description" : "The unit price of the line item." }, "margin" : { "type" : "decimal", "description" : "Reseller’s margin percentage" }, "currencyCode" : { "type" : "string", "description" : "The 3-digit ISO currency code." }, "subscriptionPeriod" : { "type" : "string", "description" : "The subscription period of the line item." } } } }, "discounts" : { "type" : "array", "items" : { "type" : "object", "properties" : { "volumeDiscounts" : { "type" : "array", "items" : { "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The 3-digit ISO currency code." }, "quantity" : { "type" : "integer", "description" : "Quantity of the line item." }, "msrp" : { "type" : "decimal", "description" : "Manufacturer Suggested Retail Price." }, "unitPrice" : { "type" : "decimal", "description" : "The unit price of the line item." }, "margin" : { "type" : "decimal", "description" : "Reseller’s margin percentage" } } } }, "specialPricing" : { "type" : "array", "items" : { "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The 3-digit ISO currency code." }, "discount" : { "type" : "decimal", "description" : "The discount for the line item." }, "discountType" : { "type" : "string", "description" : "The type of the discount" }, "discountQtyLimit" : { "type" : "integer", "description" : "The quantity available at the discounted price" }, "discountExpiryDate" : { "type" : "string", "description" : "The date when discount expires." }, "vendorProgramName" : { "type" : "string", "description" : "The vendors discount program name." } } } } } } }, "fees" : { "type" : "array", "items" : { "type" : "object", "properties" : { "price" : { "type" : "decimal", "description" : "Fee price of the line item." }, "type" : { "type" : "string", "description" : "The type of the fees." } } } } } } } } } } } } }, "ProductSearch_Response" : { "type" : "object", "properties" : { "recordsFound" : { "type" : "integer", "description" : "The number of recourds found for the search." }, "pageSize" : { "type" : "integer", "description" : "The number of results per page. Default is 25." }, "pageNumber" : { "type" : "integer", "description" : "current page number default is 1" }, "catalog" : { "type" : "array", "items" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "The description of the product." }, "category" : { "type" : "string", "description" : "The category of the product. Example: Displays." }, "subCategory" : { "type" : "string", "description" : "The sub category for the product. Example: ComputernMonitors." }, "productType" : { "type" : "string", "description" : "The product type of the product. Example: LCD Monitors." }, "ingramPartNumber" : { "type" : "string", "description" : "The Unique IngramMicro part number for the product." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor part number for the product." }, "upcCode" : { "type" : "string", "description" : "The UPC code for the product. Consists of 12 numeric digits that are uniquly assigned to each trade item." }, "vendorName" : { "type" : "string", "description" : "The name of the vendor/manufacturer of the product." }, "endUserRequired" : { "type" : "string", "description" : "Indicates whether the contact information for the end user/customer is required, which determines pricing and discounts." }, "hasDiscounts" : { "type" : "string", "description" : "Specifies if there are discounts available for the product." }, "type" : { "type" : "string", "description" : "The SKU type of product. One of Physical, Digital, or Any." }, "discontinued" : { "type" : "string", "description" : "Indicates if the product has been discontinued." }, "newProduct" : { "type" : "string", "description" : "Indicates if the product is new. For digital products, newer than 10 days. For physical products, newer than 150 days." }, "directShip" : { "type" : "string", "description" : "Indicates if the product will be shipped directly to the reseller or end user from the vendor/manufacturer." }, "hasWarranty" : { "type" : "string", "description" : "Indicates if the product has a warranty." }, "replacementSku": { "type": "string", "nullable": true }, "authorizedToPurchase": { "type": "string", "nullable": true }, "extraDescription": { "type": "string", "nullable": true }, "isMsrpVisible": { "type": "boolean" }, "isPriceVisible": { "type": "boolean" }, "customerAuthorization": { "type": "boolean" }, "skuAvailableInFeed": { "type": "boolean" }, "msrpvisibleorg": { "type": "string", "nullable": true }, "pricevisibleorg": { "type": "string", "nullable": true }, "skuinfeedorg": { "type": "string", "nullable": true }, "intorderableorg": { "type": "string", "nullable": true }, "nonintorderableorg": { "type": "string", "nullable": true }, "webvisibleorg": { "type": "string", "nullable": true }, "links" : { "type" : "array", "items" : { "type" : "object", "description" : "HATEOAS links for the price and availability of the sku.", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the product." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data.." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link(GET)" } } } } } } }, "subscriptionCatalog" : { "type" : "array", "items" : { "type" : "object", "properties" : { "groupName" : { "type" : "string", "description" : "The name of the group. (The info will shown if searched with showGroupInfo=true)" }, "groupDescription" : { "type" : "string", "description" : "The description of the group. (The info will shown if searched with showGroupInfo=true)" }, "numberOfPlans" : { "type" : "string", "description" : "The number of plans available for the group. (The info will shown if searched with showGroupInfo=true)" }, "link" : { "type" : "string", "description" : "URL to access more details about the group. (The info will shown if searched with showGroupInfo=true)" }, "plans" : { "type" : "array", "items" : { "type" : "object", "properties" : { "planId" : { "type" : "string", "description" : "ID of the Plan." }, "planName" : { "type" : "string", "description" : "Name of the Plan." }, "planDescription" : { "type" : "string", "description" : "The description of the Plan" }, "subscriptionPeriodSummary" : { "type" : "array", "items" : { "type" : "object", "properties" : { "subscriptionPeriodUnit" : { "type" : "string", "description" : "Provides the details of the product." }, "subscriptionPeriod" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data.." } } } }, "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the product." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data.." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link(GET)" } } } } } } } } } }, "nextPage" : { "type" : "string", "description" : "link/URL for accessing next page." }, "previousPage" : { "type" : "string", "description" : "link/URL for accessing previous page." } } }, "ProductDetailResponse" : { "type" : "object", "properties" : { "ingramPartNumber" : { "type" : "string", "description" : "Ingram Micro unique part number for the product." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor’s part number for the product." }, "productAuthorized" : { "type" : "boolean", "description" : "Boolean that indicates whether a product is authorized." }, "description" : { "type" : "string", "description" : "The description given for the product." }, "upc" : { "type" : "string", "description" : "The UPC code for the product. Consists of 12 numeric digits that are uniquely assigned to each trade item." }, "productCategory" : { "type" : "string", "description" : "The category of the product." }, "productSubcategory" : { "type" : "string", "description" : "The sub-category of the product." }, "vendorName" : { "type" : "string", "description" : "Vendor name for the order." }, "vendorNumber" : { "type" : "string", "description" : "Vendor number that identifies the product." }, "productStatusCode" : { "type" : "string", "description" : "Status code of the product." }, "productClass" : { "type" : "string", "description" : "Indicates whether the product is directly shipped from the vendor’s warehouse or if the product ships from Ingram Micro’s warehouse. Class Codes are Ingram classifications on how skus are stocked A = Product that is stocked usually in all IM warehouses and replenished on a regular basis. B = Product that is stocked in limited IM warehouses and replenished on a regular basis C = Product that is stocked in fewer IM warehouses and replenished on a regular basis. D = Product that Ingram Micro has elected to discontinue. E = Product that will be phased out later, according to the vendor. You may not want to replenish this product, but instead sell down what is in stock. F = Product that we carry for a specific customer or supplier under a contractual agreement. N = New Sku. Classification before first receipt O = Discontinued product to be liquidated S= Order for Specialized Demand (Order to backorder) X= direct ship from Vendor V = product that vendor has elected to discontinue." }, "customerPartNumber" : { "type" : "string", "description" : "Reseller / end-user’s part number for the product." }, "indicators" : { "type" : "array", "description" : "Indicators of the Product", "items" : { "type" : "object", "properties" : { "hasWarranty" : { "type" : "boolean", "description" : "Boolean that indicates whether product has a warranty." }, "isNewProduct" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s a new product. " }, "HasReturnLimits" : { "type" : "boolean", "description" : "Boolean that indicates whether there is any limit to return the product." }, "IsBackOrderAllowed" : { "type" : "boolean", "description" : "Boolean that indicates whether back order is allowed for the product." }, "isShippedFromPartner" : { "type" : "boolean", "description" : "Boolean that indicates whether product is shipped from the partner." }, "isReplacementProduct" : { "type" : "boolean", "description" : "Boolean that indicates whether product is a replacement product." }, "isDirectship" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s a direct ship product." }, "isDownloadable" : { "type" : "boolean", "description" : "Boolean that indicates whether product is downloadable." }, "isDigitalType" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s a digital product. " }, "skuType" : { "type" : "string", "description" : "skutype" }, "hasStdSpecialPrice" : { "type" : "boolean", "description" : "Boolean that indicates whether product has any standard special price." }, "hasAcopSpecialPrice" : { "type" : "boolean", "description" : "Boolean that indicates whether product has any ACOP special price." }, "hasAcopQuantityBreak" : { "type" : "boolean", "description" : "Boolean that indicates whether product has any ACOP quantity break." }, "hasStdWebDiscount" : { "type" : "boolean", "description" : "Boolean that indicates whether product has any standard web discount." }, "hasSpecialBid" : { "type" : "boolean", "description" : "Boolean that indicates whether product has any special bid." }, "isExportableToCountry" : { "type" : "boolean", "description" : "Boolean that indicates whether product is exportable." }, "isDiscontinuedProduct" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s a discontinued product." }, "isRefurbishedProduct" : { "type" : "boolean", "description" : "Boolean that indicates whether product is refurbished." }, "isReturnableProduct" : { "type" : "boolean", "description" : "Boolean that indicates if the product can be returned." }, "isIngramShip" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s a Ingram shipped product." }, "isEnduserRequired" : { "type" : "boolean", "description" : "Do vendor requires Enduser name required to create an order." }, "isHeavyWeight" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s heavy weight product." }, "hasLtl" : { "type" : "boolean", "description" : "Boolean that indicates whether it hasLtl or not." }, "isClearanceProduct" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s clearnce product." }, "hasBundle" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s a bundled product." }, "isOversizeProduct" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s oversized product." }, "isPreorderProduct" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s a preorder product." }, "isLicenseProduct" : { "type" : "boolean", "description" : "Boolean that indicates whether it’s a licened product." }, "isDirectshipOrderable" : { "type" : "boolean", "description" : "Boolean that indicates whether product is directship orderable." }, "isServiceSku" : { "type" : "boolean", "description" : "Boolean that indicates whether product is service SKU." }, "isConfigurable" : { "type" : "boolean", "description" : "Boolean that indicates whether product is configurable." } } } }, "ciscoFields" : { "type" : "array", "description" : "Cisco product related information.", "items" : { "type" : "object", "properties" : { "productSubGroup" : { "type" : "string", "description" : "Cisco product sub-group" }, "serviceProgramName" : { "type" : "string", "description" : "Cisco service program name" }, "itemCatalogCategory" : { "type" : "string", "description" : "Cisco item catalog category" }, "configurationIndicator" : { "type" : "string", "description" : "Cisco configuration indicator" }, "internalBusinessEntity" : { "type" : "string", "description" : "Cisco internal business entity" }, "itemType" : { "type" : "string", "description" : "Cisco item type" }, "globalListPrice" : { "type" : "string", "description" : "Cisco global list price" } } } }, "warrantyInformation" : { "type" : "array", "description" : "Warranty information related to the product.", "items" : { "type" : "object" } }, "additionalInformation" : { "type" : "object", "description" : "Additional Information related to the product.", "properties" : { "productWeight" : { "type" : "array", "description" : "Weight information related to the product.", "items" : { "type" : "object", "properties" : { "plantId" : { "type" : "string", "description" : "ID of the plant. \nExample : 'US01'" }, "weight" : { "type" : "number", "description" : "Weight of the product. \n Example : 2" }, "weightUnit" : { "type" : "string", "description" : "Weight unit of the product. \n Example : 'LB'" } } } }, "isBulkFreight" : { "type" : "boolean", "description" : "Example : true or false" }, "height" : { "type" : "string", "description" : "Example : '5.2 Inches'" }, "width" : { "type" : "string", "description" : "Example : '13 inches'" }, "length" : { "type" : "string", "description" : "Example : '20.4 inches'" }, "netWeight" : { "type" : "string", "description" : "Example : '10 lb'" }, "dimensionUnit" : { "type" : "string", "description" : "Example : 'Unit value'" } } }, "subscriptionDetails" : { "type" : "array", "description" : "Subscription product Details", "items" : { "type" : "object", "properties" : { "planId" : { "type" : "string", "description" : "ID of the subscription plan." }, "planName" : { "type" : "string", "description" : "Name of the subscription plan." }, "planDescription" : { "type" : "string", "description" : "Description of the subscription plan." }, "groups" : { "type" : "array", "description" : "Details of the groups subscription product part of.", "items" : { "type" : "object", "properties" : { "groupName" : { "type" : "string", "description" : "Name of the group." }, "groupDescription" : { "type" : "string", "description" : "Name of the subscription group." } } } }, "subscriptionPeriod" : { "type" : "array", "description" : "Details of the subscription period.", "items" : { "type" : "object", "properties" : { "subscriptionPeriodUnit" : { "type" : "string", "description" : "Unit period of the subscription. Example, Years, Months" }, "subscriptionPeriod" : { "type" : "integer", "description" : "Length of the subscription. Example 1, 3" } } } }, "billingPeriod" : { "type": "object", "description" : "Details of the subscription billing period. ", "properties" : { "billingPeriodUnit" : { "type" : "string", "description" : "Billing unit period of the subscription. Example, Years, Months" }, "billingPeriod" : { "type" : "integer", "description" : "Billing period of the subscription. Example 1, 3" } } }, "options" : { "type" : "array", "description" : "Details of the resources available.", "items" : { "type" : "object", "properties" : { "resourceId" : { "type" : "string", "description" : "ID of the subscription resource" }, "resourceName" : { "type" : "string", "description" : "Name of the subscription resource" }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor’s part number for the product." }, "minUnits" : { "type" : "integer", "description" : "Minimum units must be purchased." }, "maxUnits" : { "type" : "integer", "description" : "Maximum units are available for purchase." }, "dependsOn" : { "type" : "string", "description" : "The name of the product must be purchased to purchase this product." } } } }, "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the product." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data.." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link(GET)" } } } }, "nextPage":{ "type": "string", "description": "link/URL for accessing next page." }, "previousPage":{ "type": "string", "description": "link/URL for accessing previous page." } } } } } }, "renewalsSearchRequest" : { "type" : "object", "properties" : { "status" : { "type" : "object", "properties" : { "OpporutinyStatus" : { "type" : "object", "properties" : { "value" : { "type" : "string", "description" : "The value of opportunity status, it can be either Open or Closed." }, "subStatus" : { "type" : "string", "description" : "The sub-status of Opportunity status. Possible sub-status values for Open opportunity status are Ready to order, Quote pending, Notification sent, Future, and Quote requested. Possible sub-status values for Closed opportunity status are All, Ordered, Quote closed-contract sales desk, Expired, Transition to new/upsell, Lost to competitior, Consolidated, Transitioned to cloud, Renewal went direct, EOL, End user out of business, Void, Other, and Cancelled." } } } } }, "dateType" : { "type" : "object", "properties" : { "startDate" : { "type" : "object", "properties" : { "customStartDate" : { "type" : "string", "description" : "Custom from date for Renewal Start date." }, "customEndDate" : { "type" : "string", "description" : "Custom to date for Renewal Start date." } } }, "endDate" : { "type" : "object", "properties" : { "customStartDate" : { "type" : "string", "description" : "Custom from date for Renewal end date." }, "customEndDate" : { "type" : "string", "description" : "Custom to date for Renewal end date." } } }, "invoiceDate" : { "type" : "object", "properties" : { "customStartDate" : { "type" : "string", "description" : "Custom start date for invoice date." }, "customEndDate" : { "type" : "string", "description" : "Custom end date for invoice date." } } }, "expirationDate" : { "type" : "object", "properties" : { "customStartDate" : { "type" : "string", "description" : "Custom start date for expiration date." }, "customEndDate" : { "type" : "string", "description" : "Custom end date for expiration date." } } } } }, "vendor" : { "type" : "string", "description" : "The name of the Vendor." }, "endUser" : { "type" : "string", "description" : "The name of the enduser. " } } }, "renewalsSearchResponse" : { "type" : "object", "properties" : { "recordsFound" : { "type" : "integer", "description" : "Number of records found." }, "pageSize" : { "type" : "integer", "description" : "Number of records in a page." }, "pageNumber" : { "type" : "integer", "description" : "Number of page." }, "renewals" : { "type" : "array", "items" : { "type" : "object", "properties" : { "renewalId" : { "type" : "string", "description" : "Unique renewal ID." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's order number for reference in their system." }, "referenceNumber" : { "type" : "string", "description" : "Renewal reference number. It could be notification id or quote number." }, "endUser" : { "type" : "string", "description" : "The company name for the end user/customer." }, "vendor" : { "type" : "string", "description" : "The name of the vendor." }, "expirationDate" : { "type" : "string", "description" : "Renewal expiration date." }, "renewalValue" : { "type" : "string", "description" : "The value of the renewal." }, "status" : { "type" : "string", "description" : "The status of the renewal." }, "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "The topic of the link." }, "href" : { "type" : "string", "description" : "The URL of the topic." }, "type" : { "type" : "string", "description" : "Type of a call." } } } } } } }, "nextPage" : { "type" : "string", "description" : "URL for the next page." }, "previousPage" : { "type" : "string", "description" : "URL for the previous page." } } }, "renewalsDetailsResponse" : { "type" : "object", "properties" : { "renewalId" : { "type" : "string", "description" : "Unique Ingram renewal ID." }, "ingramOrderNumber" : { "type" : "string", "description" : "The IngramMicro sales order number." }, "ingramOrderDate" : { "type" : "string", "format": "date", "description" : "The IngramMicro sales order date." }, "expirationDate" : { "type" : "string", "format": "date", "description" : "Renewal expiration date." }, "ingramPurchaseOrderNumber" : { "type" : "string", "description" : "Ingram purchase order number." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's order number for reference in their system." }, "endCustomerOrderNumber" : { "type" : "string", "description" : "The end customer's order number for reference in their system." }, "renewalValue" : { "type" : "number", "format": "decimal", "description" : "The value of the renewal." }, "endUser" : { "type" : "string", "description" : "The company name for the end user/customer." }, "vendor" : { "type" : "string", "description" : "The name of the vendor." }, "status" : { "type" : "string", "description" : "The status of the renewal." }, "endUserInfo" : { "type" : "array", "items" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "The contact name for the end user/customer." }, "companyName" : { "type" : "string", "description" : "The company name for the end user/customer." }, "addressLine1" : { "type" : "string", "description" : "The address line 1 for the end user/customer." }, "addressLine2" : { "type" : "string", "description" : "The address line 2 for the end user/customer." }, "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", "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." } } } }, "referenceNumber" : { "type" : "array", "items" : { "type" : "object", "properties" : { "notificationId" : { "type" : "string", "description" : "Notification id of the communication sent from Ingram." }, "quoteNumber" : { "type" : "string", "description" : "Quote number for the renewal." } } } }, "products" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ingramLineNumber" : { "type" : "string", "description" : "Unique Ingram Micro line number." }, "productDescription" : { "type" : "string", "description" : "The description of the product." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor's part number for the line item." }, "ingramPartNumber" : { "type" : "string", "description" : "Unique IngramMicro part number." }, "manufacturerPartNumber" : { "type" : "string", "description" : "The manufacturer's part number for the line item." }, "quantity" : { "type" : "string", "description" : "The quantity of the line item." }, "unitPrice" : { "type" : "number", "format":"decimal", "description" : "The unit price of the line item." }, "isConsolidated" : { "type" : "string", "description" : "Is the line item consolidated? Yes or No." } } } }, "additionalAttributes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributeDescription" : { "type" : "string", "description" : "The description of the additional attribute." }, "attributeValue" : { "type" : "string", "description" : "The value of the additional attribute." }, "startDate" : { "type" : "string", "format" : "date", "description" : "The attribute start date." }, "expirationDate" : { "type" : "string", "format" : "date", "description" : "The attribute expiration date." }, "isConsolidated" : { "type" : "string", "description" : "Is the line item consolidated? Yes or No." } } } } } }, "dealsSearchResponse" : { "type" : "object", "properties" : { "recordsFound" : { "type" : "integer", "description" : "Number of records found." }, "pageSize" : { "type" : "integer", "description" : "Number of records in a page." }, "pageNumber" : { "type" : "integer", "description" : "Number of page." }, "deals" : { "type" : "array", "items" : { "type" : "object", "properties" : { "dealId" : { "type" : "string", "description" : "Deal/Special bid number." }, "version" : { "type" : "string", "description" : "Most recent version number of the deal." }, "endUser" : { "type" : "string", "description" : "The end user/customer's name." }, "vendor" : { "type" : "string", "description" : "The vendor's name." }, "dealExpiryDate" : { "type" : "string", "format":"date", "description" : "Expiration date of the deal/Special bid." }, "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "The topic of the link." }, "href" : { "type" : "string", "description" : "The URL of the topic." }, "type" : { "type" : "string", "description" : "Type of a call." } } } } } } }, "nextPage" : { "type" : "string", "description" : "URL for the next page." }, "previousPage" : { "type" : "string", "description" : "URL for the previous page." } } }, "dealsDetailsResponse" : { "type" : "object", "properties" : { "dealId" : { "type" : "string", "description" : "Deal/Special bid number." }, "version" : { "type" : "string", "description" : "Most recent version number of the deal." }, "endUser" : { "type" : "string", "description" : "The end user/customer's name." }, "extendedMsrp" : { "type" : "number", "format" :"decimal", "description" : "Extended MSRP - Manufacturer Suggested Retail Price X Quantity." }, "vendor" : { "type" : "string", "description" : "The vendor's name." }, "dealReceivedOn" : { "type" : "string", "format" :"date", "description" : "The date on which the deal starts." }, "dealExpiryDate" : { "type" : "string", "format" :"date", "description" : "Expiration date of the deal/Special bid." }, "priceProtectionEndDate" : { "type" : "string", "format" :"date", "description" : "The date on which the price protection will end." }, "currencyCode" : { "type" : "string", "description" : "Country specific currency code." }, "endUserInfo" : { "type" : "array", "items" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "The contact name for the end user/customer." }, "companyName" : { "type" : "string", "description" : "The company name for the end user/customer." }, "addressLine1" : { "type" : "string", "description" : "The address line 1 for the end user/customer." }, "addressLine2" : { "type" : "string", "description" : "The address line 2 for the end user/customer." }, "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", "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." } } } }, "products" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ingramPartNumber" : { "type" : "string", "description" : "Unique Ingram part number." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor Part number for the product." }, "upc" : { "type" : "string", "description" : "The UPC code for the product. Consists of 12 numeric digits that are uniquely assigned to each trade item." }, "productDescription" : { "type" : "string", "description" : "Description of the product." }, "msrp" : { "type" : "number", "format" : "decimal", "description" : "Manufacturer Suggested Retail Price." }, "extendedMSRP" : { "type" : "number", "format" : "decimal", "description" : "Extended MSRP - Manufacturer Suggested Retail Price X Quantity." }, "standardPrice" : { "type" : "number", "format" : "decimal", "description" : "Standard price of the line item." }, "approvedQuantity" : { "type" : "integer", "description" : "Total quantity approved for the deal." }, "remainingQuantity" : { "type" : "integer", "description" : "The quantity remaining as part of the deal for the customer to order." }, "comments" : { "type" : "string", "description" : "Comments of the deal." }, "specialConditions" : { "type" : "string", "description" : "Special conditions of the deal." }, "startDate" : { "type" : "string", "format":"date", "description" : "Start Date." }, "expirationDate" : { "type" : "string", "format":"date", "description" : "Expiration date." }, "daysRemaining" : { "type" : "integer", "description" : "Number of days remaining before the deal expires." } } } } } }, "returnsSearchResponse" : { "type" : "object", "properties" : { "recordsFound" : { "type" : "integer", "description" : "Number of records found." }, "pageSize" : { "type" : "integer", "description" : "Number of records in a page." }, "pageNumber" : { "type" : "integer", "description" : "Number of page." }, "returnsClaims" : { "type" : "array", "items" : { "type" : "object", "properties" : { "returnClaimId" : { "type" : "string", "description" : "A unique return claim Id." }, "caseRequestNumber" : { "type" : "string", "description" : "A unique return request number." }, "createdOn" : { "type" : "string", "format" : "date", "description" : "The date on which the return request was created. " }, "type" : { "type" : "string", "description" : "Type of request." }, "returnReason" : { "type" : "string", "description" : "The reason for the return." }, "referenceNumber" : { "type" : "string", "description" : "The reference number for the return." }, "estimatedTotalValue" : { "type" : "string", "format" : "date", "description" : "The estimated total value of the return." }, "credit" : { "type" : "number", "format" : "decimal", "description" : "The amount of credit." }, "modifiedOn" : { "type" : "string", "description" : "The date on which the return request was last updated." }, "status" : { "type" : "string", "description" : "The status of the request." }, "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the return." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link (GET, POST, Etc.)." } } } } } } }, "nextPage" : { "type" : "string", "description" : "URL for the next page." }, "previousPage" : { "type" : "string", "description" : "URL for the previous page." } } }, "returnsDetailsResponse" : { "type" : "object", "properties" : { "typeOfDetails" : { "type" : "string", "description" : "The type of the details. Return or Claim." }, "rmaClaimId" : { "type" : "string", "description" : "The rmaClaimId claim id." }, "caseRequestNumber" : { "type" : "string", "description" : "A unique return request number." }, "createdOn" : { "type" : "string", "format" : "date", "description" : "The date on which the return request was created." }, "returnReason" : { "type" : "string", "description" : "The reason for the return." }, "referenceNumber" : { "type" : "string", "description" : "The reference number for the return." }, "status" : { "type" : "string", "description" : "The status of the request." }, "returnWarehouseAddress" : { "type" : "string", "description" : "The address of the return warehouse." }, "products" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ingramLineNumber" : { "type" : "string", "description" : "Unique Ingram Micro line number." }, "description" : { "type" : "string", "description" : "The description of the line item product." }, "ingramPartNumber" : { "type" : "string", "description" : "Unique IngramMicro part number." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor's part number for the line item." }, "upc" : { "type" : "string", "description" : "The UPC code of a product." }, "invoiceDate" : { "type" : "string", "format" : "date", "description" : "The date of the invoice." }, "invoiceNumber" : { "type" : "string", "description" : "Ingram micro Invoice number." }, "customerOrderNumber" : { "type" : "integer", "description" : "The reseller's order number for reference in their system." }, "requestDetails" : { "type" : "integer", "description" : "Request details." }, "quantity" : { "type" : "integer", "description" : "The quantity of the line item." }, "unitPrice" : { "type" : "number", "format" : "decimal", "description" : "The unit price of the line item." }, "extendedPrice" : { "type" : "number", "format" : "decimal", "description" : "Unit price X quantity for the line item." }, "status" : { "type" : "string", "description" : "The status of the line item." }, "returnBranch" : { "type" : "integer", "description" : "The code of the return branch." }, "shipFromBranch" : { "type" : "integer", "description" : "The code of the ship from branch." } } } }, "subTotal" : { "type" : "number", "format" : "decimal", "description" : "Sub total amount of the return request." }, "tax" : { "type" : "number", "format" : "decimal", "description" : "The tax amount of the return request." }, "additionalFees" : { "type" : "number", "format" : "decimal", "description" : "The additional fees for the return request." }, "estimatedTotal" : { "type" : "number", "format" : "decimal", "description" : "The total estimated amount for the return request." } } }, "returnsCreateRequest" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "properties" : { "invoiceNumber" : { "type" : "string", "description" : "The Invoice number of the order." }, "invoiceDate" : { "type" : "string", "format" : "date", "description" : "Date of an Invoice." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's order number for reference in their system." }, "ingramPartNumber" : { "type" : "string", "description" : "Unique line number from Ingram." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor Part Number." }, "serialNumber" : { "type" : "string", "description" : "Serial number of the product." }, "quantity" : { "type" : "integer", "description" : "Return quantity of the product." }, "primaryReason" : { "type" : "string", "description" : "Primary reason to return the product.
List of Primary reasons (please choose one)
" }, "secondaryReason" : { "type" : "string", "description" : "Secondary reason to return the product.
List of Secondary reasons (please choose one)
" }, "notes" : { "type" : "string", "description" : "Return notes." }, "referenceNumber" : { "type" : "string", "description" : "Reference number to return the product." }, "billToAddressId" : { "type" : "string", "description" : "Suffix used to identify billing address." }, "shipFromInfo" : { "type" : "array", "items" : { "properties" : { "companyName" : { "type" : "string", "description" : "Name of the company from where the product will be shipped." }, "contact" : { "type" : "string", "description" : "Contact name of the person from where the product will be shipped." }, "addressLine1" : { "type" : "string", "description" : "Ship from Address Line1." }, "addressLine2" : { "type" : "string", "description" : "Ship from Address Line2." }, "city" : { "type" : "string", "description" : "Ship from City." }, "state" : { "type" : "string", "description" : "Ship from state." }, "postalCode" : { "type" : "string", "description" : "Ship from postal code." }, "countryCode" : { "type" : "string", "description" : "ship from country code." }, "email" : { "type" : "string", "description" : "Ship from email." }, "phoneNumber" : { "type" : "string", "description" : "Ship from phone number." } }, "required" :["companyName", "contact", "addressLine1", "city", "state", "postalCode", "countryCode", "email"] } }, "numberOfBoxes" : { "type" : "integer", "description" : "Number of boxes to return." } }, "required" : ["invoiceNumber", "invoiceDate", "quantity", "primaryReason", "secondaryReason", "shipFromInfo", "numberOfBoxes"] } } } }, "returnsCreateResponse" : { "type" : "object", "properties" : { "returnsClaims" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rmaClaimId" : { "type" : "string", "description" : "The rmaClaimId claim id." }, "caseRequestNumber" : { "type" : "string", "description" : "A unique return request number." }, "referenceNumber" : { "type" : "string", "description" : "The reference number for the return." }, "createdOn" : { "type" : "string", "format":"date", "description" : "The date on which the return request was created. " }, "type" : { "type" : "string", "description" : "Type of request." }, "returnReason" : { "type" : "string", "description" : "The reason for the return." }, "ingramPartNumber" : { "type" : "string", "description" : "Unique line number from Ingram." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor Part Number." }, "quantity" : { "type" : "integer", "description" : "Return quantity of the product." }, "notes" : { "type" : "string", "description" : "Return notes." }, "estimatedTotalValue" : { "type" : "number", "format":"decimal", "description" : "The estimated total value of the return." }, "credit" : { "type" : "number", "format":"decimal", "description" : "The amount of credit." }, "status" : { "type" : "string", "description" : "The status of the request." }, "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the return." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link (GET, POST, Etc.)." } } } } } } } } }, "freightRequest" : { "type" : "object", "properties" : { "billToAddressId" : { "type" : "string", "description" : "Suffix used to identify billing address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit." }, "shipToAddressId" : { "type" : "string", "description" : "The ID references the reseller's address in Ingram Micro's system for shipping. Provided to resellers during the onboarding process." }, "shipToAddress" : { "type":"object", "description":"The shipping information.", "properties":{ "companyName":{ "type":"string", "description":"The reseller's company name or the End-User's Name" }, "addressLine1":{ "type":"string", "description":"Line 1 of the address the order will be shipped to." }, "addressLine2":{ "type":"string", "description":"Line 2 of the address the order will be shipped to." }, "city":{ "type":"string", "description":"The city the order will be shipped to." }, "state":{ "type":"string", "description":"The state the order will be shipped to." }, "postalCode":{ "type":"string", "description":"The zip or postal code the order will be shipped to." }, "countryCode":{ "type":"string", "description":"The two-character ISO country code the order will be shipped to." } } }, "lines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "customerLineNumber" : { "type" : "string", "description" : "The ID references the reseller's address in Ingram Micro's system for shipping. Provided to resellers during the onboarding process." }, "ingramPartNumber" : { "type" : "string", "description" : "The unique IngramMicro part number." }, "quantity" : { "type" : "string", "description" : "The requested quantity of the line item." }, "warehouseId" : { "type" : "string", "description" : "The ID of the warehouse the line item will ship from." }, "carrierCode" : { "type" : "string", "description" : "The code for the shipping carrier for the line item." } } } } } }, "freightResponse" : { "type" : "object", "properties" : { "freightEstimateResponse" : { "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The country-specific three-character ISO 4217 currency code used for the order." }, "totalFreightAmount" : { "type" : "number", "format" : "decimal", "description" : "Total freight amount." }, "totalTaxAmount" : { "type" : "number", "format" : "decimal", "description" : "Total tax amount." }, "totalFees" : { "type" : "number", "format" : "decimal", "description" : "Total fees." }, "totalNetAmount" : { "type" : "number", "format" : "decimal", "description" : "Total net amount." }, "grossAmount" : { "type" : "number", "format" : "decimal", "description" : "Gross amount." }, "distribution" : { "type" : "array", "items" : { "type" : "object", "properties" : { "shipFromBranchNumber" : { "type" : "string", "description" : "The ID of the warehouse the line item will ship from." }, "carrierCode" : { "type" : "string", "description" : "The code for the shipping carrier for the line item." }, "shipVia" : { "type" : "string", "description" : "The name of the shipping carrier." }, "freightRate" : { "type" : "number", "format" : "decimal", "description" : "Estimated freight charge." }, "totalWeight" : { "type" : "number", "format" : "decimal", "description" : "Total weight." }, "transitDays" : { "type" : "integer", "description" : "Number of transit days." }, "carrierList" : { "type" : "array", "items" : { "type" : "object", "properties" : { "carrierCode" : { "type" : "string", "description" : "The code for the shipping carrier for the line item." }, "shipVia" : { "type" : "string", "description" : "The name of the shipping carrier." }, "carrierMode" : { "type" : "string", "description" : "Mode of the carrier." }, "estimatedFreightCharge" : { "type" : "number", "format" : "decimal", "description" : "Estimated freight charge." }, "daysInTransit" : { "type" : "integer", "description" : "Number of transit days." } } } } } } }, "lines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ingramPartNumber" : { "type" : "string", "description" : "The unique IngramMicro part number." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor part number for the line item." }, "warehouseId" : { "type" : "string", "description" : "The ID of the warehouse the line item will ship from." }, "quantity" : { "type" : "integer", "description" : "The requested quantity of the line item." }, "unitPrice" : { "type" : "number", "format" : "decimal", "description" : "The unit price for the line item." }, "netAmount" : { "type" : "number", "format" : "decimal", "description" : "The net amount (unit price X quantity) for the line item." } } } } } } } }, "QuoteSearchResponse" : { "type" : "object", "properties" : { "recordsFound" : { "type" : "integer", "description" : "Total count of quotes retrieved in the request response." }, "pageSize" : { "type" : "integer", "description" : "Number of records (quotes) displayed per page in the quote list." }, "pageNumber" : { "type" : "integer", "description" : "Page index or page number for the list of quotes being returned." }, "quotes" : { "type" : "array", "description" : "The quote details for the requested criteria.", "items" : { "properties" : { "quoteGuid": { "type": "string", "description": "Ingram MIcro’s Quote GUID" }, "quoteName" : { "type" : "string", "description" : "Quote Name given to quote by sales team or system generated. Generally used as a reference to identify the quote." }, "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micros CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes." }, "revision" : { "type" : "string", "description" : "When a quote has been revised and updated, the quote number remains the same throughout the lifecycle of the quote, however, a Revision number is updated for each revision of the quote. The revision numbers is associated with the Unique Quote Number." }, "currencyCode": { "type": "string", "description": "The country-specific three digit ISO 4217 currency code for the order." }, "endUserContact" : { "type" : "string", "description" : "End User Name is the end customer name that is associated with a quote in Ingram Micros CRM." }, "specialBidNumber" : { "type" : "string", "description" : "Special Pricing Bid Number, also refers to as Dart Number relates to a unique pricing deal associated with a vendor for the quote." }, "quoteTotal" : { "type" : "number", "format" : "decimal", "description" : "Total amount of quoted price for all products in the quote." }, "quoteStatus" : { "type" : "string", "description" : "This refers to the primary status of the quote." }, "ingramQuoteDate" : { "type" : "date", "description" : "Date the Quote was initially Created." }, "lastModifiedDate" : { "type" : "string", "description" : "date the Quote was last updated or modified." }, "ingramQuoteExpiryDate" : { "type" : "date", "description" : "Date when the Quote Expires." }, "endUserName":{ "type": "string", "description": "The company name for the end user/customer." }, "vendor" : { "type" : "string", "description" : "Name of the vendor." }, "createdBy" : { "type" : "string", "description" : "Name of the end user/customer who created a quote." }, "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "topic": { "type": "string", "description": "Provides link to the details of the quote." }, "href":{ "type": "string", "description": "The URL endpoint for accessing the relevant data." }, "type":{ "type": "string", "description": "The type of call that can be made to the href link(GET)" } } } } } } } } }, "QuoteDetailsResponse" : { "type" : "object", "properties" : { "quoteName" : { "type" : "string", "description" : "Quote Name given to quote by sales team or system generated. Generally used as a reference to identify the quote." }, "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes." }, "quoteGuid":{ "type": "string", "description": "Ingram MIcro’s Quote GUID" }, "revision" : { "type" : "string", "description" : "When a quote has been revised and updated, the quote number remains the same throughout the lifecycle of the quote, however, a Revision number is updated for each revision of the quote. The revision numbers is associated with the Unique Quote Number." }, "ingramQuoteDate" : { "type" : "date", "description" : "Date the Quote was initially Created." }, "lastModifiedDate" : { "type" : "date", "description" : "Date the Quote was last updated or modified." }, "ingramQuoteExpiryDate" : { "type" : "date", "description" : "Quote expiration date." }, "currencyCode" : { "type" : "string", "description" : "Three letter currency code." }, "specialBidId" : { "type" : "string", "description" : "Price discount identifyer to specify a pricing discount that has been applied to the quote. If present - the priceDeviationStartDate and priceDeviationExpiryDate must be presented. Cisco refers to this as a Dart" }, "specialBidEffectiveDate" : { "type" : "date", "description" : "If price discount has been applied to the quote - the starting date the discount begins." }, "specialBidExpirationDate" : { "type" : "date", "description" : "If a price discount has been applied to the quote - The date the discount expires and will no longer be applicable." }, "vendorQuoteNumber":{ "type": "string", "description": "Quote Number in the vendor’s system." }, "status" : { "type" : "string", "description" : "This refers to the primary status of the quote. API responses will return" }, "statusReason":{ "type": "string", "description": "Explanation of the status reason." }, "closingReason":{ "type": "string", "description": "Reson for closing the quote." }, "dateClosed":{ "type": "string", "description": "A date on which the quote closed." }, "customerNeed" : { "type" : "string", "description" : "Details related to the customer's request for the quote entered by the sales representative or system generated." }, "proposedSolution" : { "type" : "string", "description" : "Ingram Micro proposed solution and summary of quote." }, "introPreamble" : { "type" : "string", "description" : "Introductory paragraph included in each quote. Legally required - must be included when presenting the quote details." }, "purchaseInstructions" : { "type" : "string", "description" : "Purchase instructions. Legally required - must be included when presenting the quote details." }, "legalTerms" : { "type" : "string", "description" : "Legal terms - Legally required - must be included when presenting the quote details." }, "leaseInfo" : { "type" : "string", "description" : "Lease information." }, "leasingInstructions" : { "type" : "string", "description" : "Leasing information" }, "imWarehouse" : { "type" : "string", "description" : "Address of the Ingram warehouse." }, "imWarehouseGstNumber" : { "type" : "string", "description" : "GST number of the warehouse." }, "paymentTermsName" : { "type" : "string", "description" : "Name of the payment terms." }, "quoteType": { "type" : "string", "description" : "Type of quote." }, "resellerInfo" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "Contact Name" }, "companyName" : { "type" : "string", "description" : "Ingram Micro Customer's Account Name" }, "email" : { "type" : "string", "description" : "Account Contact Email Address" }, "phoneNumber" : { "type" : "string", "description" : "Account Phone Number" }, "customerNumber" : { "type" : "string", "description" : "Reseller account number" } } }, "endUserInfo" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "End User Name" }, "companyName" : { "type" : "string", "description" : "Contact name of end user associated with the quote." }, "addressLine1" : { "type" : "string", "description" : "Address line 1 for end user associated with the quote" }, "addressLine2" : { "type" : "string", "description" : "Address line 2 for end user associated with the quote." }, "addressLine3" : { "type" : "string", "description" : "Address line 3 for end user associated with the quote." }, "city" : { "type" : "string", "description" : "City for end user associated with the quote" }, "state" : { "type" : "string", "description" : "Two letter state abreviation for end user associated with the quote" }, "email" : { "type" : "string", "description" : "Email of end user the quote associated with the quote." }, "phoneNumber" : { "type" : "string", "description" : "Phone number of end user associated with the quote." }, "postalCode" : { "type" : "string", "description" : "Zip code of end user associated with the quote." }, "marketSegment" : { "type" : "string", "description" : "Market Segment of end user associated with the quote. End user market segment is included when end user is included in specific market segments like Educational, Government, Military, Medical - that may receive special pricing due to their segmentation." } } }, "shippingInfo" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "End User Name" }, "companyName" : { "type" : "string", "description" : "The name of the company where the shipment will be sent." }, "addressLine1" : { "type" : "string", "description" : "Shipping company address line 1." }, "addressLine2" : { "type" : "string", "description" : "Shipping company address line 2." }, "city" : { "type" : "string", "description" : "Shipping company city." }, "state" : { "type" : "string", "description" : "Two letter state abbreviation if the Shipping company state." }, "email" : { "type" : "string", "description" : "Email of the shipping company." }, "phoneNumber" : { "type" : "string", "description" : "Phone number of the shipping company." }, "postalCode" : { "type" : "string", "description" : "Zip code of the shipping company." }, "shipToGstinNUmber" : { "type" : "string", "description" : "GST Number of the ship to company." } } }, "products" : { "type" : "array", "items" : { "type" : "object", "properties" : { "quoteProductGuid" : { "type" : "string", "description" : "Quote Product GUID is the primary quote key in Ingram Micro's CRM - needed to retrieve quote details." }, "lineNumber" : { "type" : "string", "description" : "Line number which the product will appear in the quote. Line number is manditory when unique configurations are included in a quote and mainting the item line order is required." }, "quantity" : { "type" : "integer", "description" : "Quantity of product line item quoted." }, "notes" : { "type" : "string", "description" : "Product line item comments." }, "EAN" : { "type" : "string", "description" : "EANUPC" }, "CoO" : { "type" : "string", "description" : "Country of Origin." }, "ingramPartNumber" : { "type" : "string", "description" : "Ingram Micro SKU (stock keeping unit). An identification, usually alphanumeric, of a particular product that allows it to be tracked for inventory purposes" }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor Part Number" }, "description" : { "type" : "string", "description" : "Product description. Note - The quote view api returns only the product short description as maintained in Ingram Micro's crm system. For long descriptions, please refer to alternative information sources." }, "weight" : { "type" : "integer", "description" : "Weight is provided based on country standard. For countries following Imperial standards - weight is presented as pounds with decimal. In countries following metric standards, weight is provided as kilograms with decimal." }, "weightUom" : { "type" : "string", "description" : "Unit of measure" }, "isSuggestionProduct" : { "type" : "boolean", "description" : "Flag to indicate if a product line item is a suggested product. The suggested product is provided in addition to the requested quoted products and a suggested option. Suggested products are grouped together for subtotal and total calculations." }, "vpnCategory" : { "type" : "string", "description" : "Vendor product category specific to Cisco. HWDW (hardware) or service." }, "isSubscription":{ "type": "boolean", "description": "Is subscription product? value is either true or false." }, "quoteProductsSupplierPartAuxiliaryId" : { "type" : "string", "description" : "Vendor product configuration ID specific to Cisco." }, "vendorName" : { "type" : "string", "description" : "Vendor name of the product" }, "terms" : { "type" : "string", "description" : "Terms of the quote" }, "resellerMargin":{ "type" : "percentage", "description" : "Reseller’s margin percentage" }, "planDescription":{ "type" : "string", "description" : "Description of the plan." }, "requestedStartDate":{ "type" : "string", "description" : "Start date for the renewal." }, "startDate":{ "type" : "string", "description" : "Reseller’s margin percentage" }, "endDate":{ "type" : "string", "description" : "End date for the renewal." }, "serialNumber":{ "type" : "string", "description" : "Serial number of the renewal product." }, "price" : { "type" : "object", "properties" : { "quotePrice" : { "type" : "integer", "description" : "Ingram Micro quoted price specific to the reseller and quote." }, "msrp" : { "type" : "integer", "description" : "Manufacturer Suggested Retail Price" }, "extendedMsrp" : { "type" : "integer", "description" : "Extended MSRP - Manufacturer Suggested Retail Price X Quantity" }, "extendedQuotePrice" : { "type" : "integer", "description" : "Extended reseller quoted price (cost to reseller) X Quantity" }, "discountOffList" : { "type" : "number", "format":"decimal", "description" : "Discount off list percentage" }, "type":{ "type" : "string", "description" : "" }, "recurringPriceModel":{ "type" : "string", "description" : "" }, "unitOfMeasure":{ "type" : "string", "description" : "Unit of the measure for the product. Example, Per user." }, "tax":{ "type" : "decimal", "description" : "Line level tax of the product." }, "extraFees":{ "type": "decimal", "description": "Line level total of all the extra fees." }, "extraFeesDetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "extraFeesDescription":{ "type": "string", "description": "Description of the extra fees at a line level." }, "extraFeesAmount":{ "type": "string", "description": "Amount of the extra fees at a line level." } } } }, "discounts" : { "type" : "array", "items" : { "type" : "object", "properties" : { "type":{ "type": "string", "description": "Type of discount" }, "amount":{ "type": "decimal", "description": "Discounted amount." }, "expirationDate":{ "type": "string", "description": "Date when discount will expire." }, "description":{ "type": "string", "description": "Description of the discount." }, "availableQuantity":{ "type": "integer", "description": "Quantity is available at a discounted price." }, "minimumQuantity":{ "type": "integer", "description": "Minimum quantity required to purchase to qualify for a discount." }, "bidNumber":{ "type": "string", "description": "Bid Number for a discount." }, "bidVersion":{ "type": "string", "description": "The Version number of the bid." }, "validFrom":{ "type": "string", "description": "A date from which the discount is valid." }, "validTo":{ "type": "string", "description": "A date til which the discount is valid." }, "discountOffList":{ "type": "decimal", "description": "Discount off list percentage." } } } } } }, "billDetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "type":{ "type": "string", "description": "Type of billing details. for example Billing Period Details or Subscription Period Details" }, "unit":{ "type": "string", "description": "Unit for billing Details" }, "frequency":{ "type": "integer", "description": "Frequency for billing Details" }, "unitValue":{ "type": "string", "description": "Unit-value for billing Details" } } } } } } }, "productsCount" : { "type" : "integer", "description" : "Total number of products included in the quote" }, "quantityTotal" : { "type" : "integer", "description" : "Total quantity of all items in the quote." }, "extendedMsrpTotal" : { "type" : "integer", "description" : "Total extended MSRP for all products included in the quote" }, "extraFeesTotal" : { "type" : "decimal", "description" : "A Sum of all the extra fees." }, "extraFeesTotalDetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "extraFeesDescription" : { "type" : "string", "description" : "Description of the extra fees at a line level." }, "extraFeesAmount" : { "type" : "decimal", "description" : "Amount of the extra fees at a line level." } } } }, "taxTotal" : { "type" : "decimal", "description" : "" }, "extendedQuotePriceTotal" : { "type" : "integer", "description" : "Total amount of quoted price for all products in the quote including both solution products and suggested products." }, "freightAmount" : { "type" : "decimal", "description" : "Amount of the extra fees at a line level." }, "totalQuoteAmount" : { "type" : "decimal", "description" : "A total amount of the Quote." }, "additionalAttributes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "**estimateId -** is the identification number for an estimate provided by Cisco for a quote.\n\n**dealId -** is the identification number for the specific deal pricing related to a Cisco quote\n\n**vendorName -** Name of Vendor associated with the quote.\n\n**vendorMessage -** Vendor Message is associated with primary vendor in the quote. In cases where a vendor requires a message be presented in the quote, the vendor name and message will be retreived and must be included in the quote vendor message fields." }, "attributeValue" : { "type" : "string", "description":"The attribute field data." } } } } } }, "AvailabilityAsyncNotificationRequest" : { "type" : "object", "required" : [ "customerOrderNumber" ], "properties" : { "topic" : { "type" : "string", "description" : "Field for identifying whether it is a reseller or vendor event. For eg, resellers/orders" }, "event" : { "type" : "string", "description" : "The event sent in the request. For eg, im::create." }, "eventTimeStamp" : { "type" : "string", "description" : "The timestamp at which the event was sent." }, "eventId" : { "type" : "string", "description" : "A unique id used as identifier for the sepcific event and used for generating the x-hub signature." }, "resource" : { "type" : "array", "items" : { "type" : "object", "properties" : { "eventType" : { "type" : "string", "description" : "The event name sent in the event request." }, "ingramPartNumber" : { "type" : "string", "description" : "The Unique IngramMicro part number for the product." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendors part number for the product." }, "vendorName" : { "type" : "string", "description" : "The name of the vendor/manufacturer of the product." }, "upcCode" : { "type" : "string", "description" : "The UPC code for the product. Consists of 12 numeric digits that are uniquly assigned to each trade item." }, "skuStatus" : { "type" : "string", "description" : "Status returned saying whether sku is active." }, "backOrderFlag" : { "type" : "string", "description" : "Backordered Flag." }, "totalAvailability" : { "type" : "string", "description" : "totalAvailability." }, "links" : { "type" : "array", "description" : "Link to Order Details for the order(s).", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the orders." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link (GET, POST, Etc.). " } } } } } } } } }, "OrdercreateWebhook": { "type": "object", "required": [ "customerOrderNumber" ], "properties": { "topic": { "type": "string", "description": "Field for identifying whether it is a reseller or vendor event. For eg, resellers/orders" }, "event": { "type": "string", "description": "The event sent in the request. For eg, im::create." }, "eventTimeStamp": { "type": "string", "description": "The timestamp at which the event was sent." }, "eventId": { "type": "string", "description": "A unique id used as identifier for the sepcific event and used for generating the x-hub signature." }, "resource" : { "type" : "array", "items" : { "type" : "object", "properties" : { "message": { "type": "string", "description": "" }, "reason": { "type": "string", "description": "" }, "quoteName": { "type": "string", "description": "Quote Name given to quote by sales team or system generated. Generally used as a reference to identify the quote." }, "quoteNumber": { "type": "string", "description": "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes." }, "quoteGuid": { "type": "string", "description": "Ingram MIcro’s Quote GUID" }, "revision": { "type": "string", "description": "When a quote has been revised and updated, the quote number remains the same throughout the lifecycle of the quote, however, a Revision number is updated for each revision of the quote. The revision numbers is associated with the Unique Quote Number." }, "ingramQuoteDate": { "type": "date", "description": "Date the Quote was initially Created." }, "lastModifiedDate": { "type": "date", "description": "Date the Quote was last updated or modified." }, "ngramQuoteExpiryDate": { "type": "date", "description": "Quote expiration date." }, "currencyCode": { "type": "string", "description": "Three letter currency code." },"specialBidId": { "type": "string", "description": "Price discount identifyer to specify a pricing discount that has been applied to the quote. If present - the priceDeviationStartDate and priceDeviationExpiryDate must be presented. Cisco refers to this as a Dart." }, "specialBidEffectiveDate": { "type": "date", "description": "If price discount has been applied to the quote - the starting date the discount begins." },"specialBidExpirationDate": { "type": "date", "description": "If a price discount has been applied to the quote - The date the discount expires and will no longer be applicable." },"status": { "type": "string", "description": "This refers to the primary status of the quote. API responses will return" },"closingReason": { "type": "string", "description": "Reason for closing the quote." },"dateClosed": { "type": "string", "description": "A date on which the quote closed." },"customerNeed": { "type": "string", "description": "Details related to the customer's request for the quote entered by the sales representative or system generated." },"proposedSolution": { "type": "string", "description": "Ingram Micro proposed solution and summary of quote." }, "introPreamble": { "type": "string", "description": "Introductory paragraph included in each quote. Legally required - must be included when presenting the quote details." }, "purchaseInstructions": { "type": "string", "description": "Purchase instructions. Legally required - must be included when presenting the quote details." }, "legalTerms": { "type": "string", "description": "Legal terms - Legally required - must be included when presenting the quote details." }, "leaseInfo": { "type": "string", "description": "Lease information" }, "leasingInstructions": { "type": "string", "description": "Leasing information" }, "quoteType": { "type": "string", "description": "Type of quote." }, "resellerInfo": { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "Contact Name" }, "companyName" : { "type" : "string", "description" : "Ingram Micro Customer's Account Name" }, "email" : { "type" : "string", "description" : "Account Contact Email Address" }, "phoneNumber" : { "type" : "string", "description" : "Account Phone Number" },"customerNumber" : { "type" : "string", "description" : "Reseller account number" } } }, "endUserInfo": { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "End User Name" }, "companyName" : { "type" : "string", "description" : "Contact name of end user associated with the quote." }, "addressLine1" : { "type" : "string", "description" : "Address line 1 for end user associated with the quote" }, "addressLine2" : { "type" : "string", "description" : "Address line 2 for end user associated with the quote" }, "addressLine3" : { "type" : "string", "description" : "Address line 3 for end user associated with the quote" }, "city" : { "type" : "string", "description" : "City for end user associated with the quote" }, "state" : { "type" : "string", "description" : "Two letter state abreviation for end user associated with the quote" }, "email" : { "type" : "string", "description" : "Email of end user the quote associated with the quote" },"phoneNumber" : { "type" : "string", "description" : "Phone number of end user associated with the quote." },"postalCode" : { "type" : "string", "description" : "Zip code of end user associated with the quote." },"marketSegment" : { "type" : "string", "description" : "Market Segment of end user associated with the quote. End user market segment is included when end user is included in specific market segments like Educational, Government, Military, Medical - that may receive special pricing due to their segmentation." } } }, "Products " : { "type" : "array", "items" : { "type" : "object", "properties" : { "quoteProductGuid" : { "type" : "string", "description" : "Quote Product GUID is the primary quote key in Ingram Micro's CRM - needed to retrieve quote details." }, "lineNumber":{ "type": "string", "description": "Line number which the product will appear in the quote. Line number is manditory when unique configurations are included in a quote and mainting the item line order is required." }, "quantity":{ "type": "integer", "description": "Quantity of product line item quoted." }, "notes":{ "type": "string", "description": "Product line item comments." }, "ean":{ "type": "string", "description": "EANUPC" },"coo":{ "type": "string", "description": "Ingram Micro SKU (stock keeping unit). An identification, usually alphanumeric, of a particular product that allows it to be tracked for inventory purposes" },"vendorPartNumber":{ "type": "string", "description": "Vendor Part Number" },"description":{ "type": "string", "description": "Product description. Note - The quote view api returns only the product short description as maintained in Ingram Micro's crm system. For long descriptions, please refer to alternative information sources." },"weight":{ "type": "integer", "description": "Weight is provided based on country standard. For countries following Imperial standards - weight is presented as pounds with decimal. In countries following metric standards, weight is provided as kilograms with decimal." },"weightUom":{ "type": "string", "description": "Unit of measure" },"isSuggestionProduct":{ "type": "boolean", "description": "Flag to indicate if a product line item is a suggested product. The suggested product is provided in addition to the requested quoted products and a suggested option. Suggested products are grouped together for subtotal and total calculations." },"vpnCategory":{ "type": "string", "description": "Vendor product category specific to Cisco. HWDW (hardware) or service." },"quoteProductsSupplierPartAuxiliaryId":{ "type": "string", "description": "Vendor product configuration ID specific to Cisco." },"vendorName":{ "type": "string", "description": "Vendor name of the product." },"terms":{ "type": "string", "description": "Terms of the quote" },"planDescription":{ "type": "string", "description": "Description of the plan" },"isSubscription":{ "type": "boolean", "description": "Is subscription product? value is either true or false." },"resellerMargin":{ "type": "percentage", "description": "Reseller’s margin percentage" },"test":{ "type": "string", "description": "" } } } }, "price": { "type" : "object", "properties" : { "quotePrice" : { "type" : "decimal", "description" : "Ingram Micro quoted price specific to the reseller and quote." }, "msrp" : { "type" : "decimal", "description" : "Manufacturer Suggested Retail Price" }, "extendedMsrp" : { "type" : "decimal", "description" : "Extended MSRP - Manufacturer Suggested Retail Price X Quantity" }, "extendedQuotePrice" : { "type" : "decimal", "description" : "Extended reseller quoted price (cost to reseller) X Quantity" }, "discountOffList" : { "type" : "decimal", "description" : "Discount off list percentage." }, "totalVisibleReserveQuantity" : { "type" : "string", "description" : "Total Visible Reserve Quantity" }, "recurringPriceModel" : { "type" : "string", "description" : "Recurring Price Model of the product" } } }, "productsCount": { "type":"integer", "description": "Total number of products included in the quote" }, "extendedMsrpTotal": { "type":"integer", "description": "Total extended MSRP for all products included in the quote" }, "quantityTotal": { "type":"integer", "description": "Total quantity of all items in the quote." }, "extendedQuotePriceTotal": { "type":"integer", "description": "Total amount of quoted price for all products in the quote including both solution products and suggested products." }, "totalVat":{ "type": "decimal", "description": "Total Tax" }, "totalQuoteAmount":{ "type": "decimal", "description": "A total amount of the Quote." }, "freightAmount":{ "type": "decimal", "description": "Amount of the extra fees at a line level." }, "additionalAttributes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "estimateId - is the identification number for an estimate provided by Cisco for a quote. dealId - is the identification number for the specific deal pricing related to a Cisco quote vendorName - Name of Vendor associated with the quote.vendorMessage - Vendor Message is associated with primary vendor in the quote. In cases where a vendor requires a message be presented in the quote, the vendor name and message will be retreived and must be included in the quote vendor message fields." }, "attributeValue": { "type": "string", "description": "The attribute field data." } } } }, "invalidSKUs": { "type": "string", "description": "List of invalid SKUs" } } } } } }, "OrderStatusAsyncNotificationRequest" : { "type" : "object", "required" : [ "customerOrderNumber" ], "properties" : { "topic" : { "type" : "string", "description" : "Field for identifying whether it is a reseller or vendor event. For eg, resellers/orders" }, "event" : { "type" : "string", "description" : "The event sent in the request. For eg, im::create." }, "eventTimeStamp" : { "type" : "string", "description" : "The timestamp at which the event was sent." }, "eventId" : { "type" : "string", "description" : "A unique id used as identifier for the sepcific event and used for generating the x-hub signature." }, "resource" : { "type" : "array", "items" : { "type" : "object", "properties" : { "eventType" : { "type" : "string", "description" : "The event name sent in the event request." }, "orderNumber" : { "type" : "string", "description" : "The Ingram Micro order number." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's unique PO/Order number." }, "orderEntryTimeStamp" : { "type" : "string", "description" : "The timestamp at which the order was created." }, "lines" : { "type" : "array", "description" : "The line-level details for the order.", "items" : { "type" : "object", "properties" : { "LineNumber" : { "type" : "string", "description" : "The Ingram Micro line number for the product" }, "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "lineStatus" : { "type" : "string", "description" : "The status for the line item in the order. One of: Backordered, Open, Shipped" }, "ingramPartNumber" : { "type" : "string", "description" : "The Ingram Micro part number for the line item." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor part number for the line item." }, "requestedQuantity" : { "type" : "string", "description" : "The quantity of the line item requested." }, "shippedQuantity" : { "type" : "string", "description" : "The quantity of the line item that has been shipped." }, "backorderedQuantity" : { "type" : "string", "description" : "The quantity of the line item that is backordered." }, "shipmentDetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "shipmentDate" : { "type" : "string", "description" : "The date the line item was shipped." }, "shipFromWarehouseId" : { "type" : "string", "description" : "The ID of the warehouse the product will ship from." }, "warehouseName" : { "type" : "string", "description" : "\"\"" }, "carrierCode" : { "type" : "string", "description" : "The carrier code for the shipment containing the\n line item." }, "carrierName" : { "type" : "string", "description" : "The name of the carrier of the shipment containing\n the line item." }, "packageDetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "cartonNumber" : { "type" : "string", "description" : "The shipment carton number that contains the line item." }, "quantityInbox" : { "type" : "string", "description" : "The quantity of line items in the box." }, "trackingNumber" : { "type" : "string", "description" : "The tracking number for the shipment containing the line item." } } } } } } }, "serialNumberDetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "serialNumber" : { "type" : "string", "description" : "The serial number for the line item. " } } } }, "customerLineNumber" : { "type" : "string", "maxLength" : 3, "description" : "The reseller's line item number for reference in their system." } } } }, "links" : { "type" : "array", "description" : "Link to Order Details for the order(s).", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the orders." }, "href" : { "type" : "string", "description" : "The URL endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link (GET, POST, Etc.). " } } } } } } } } }, "InvoiceSearchResponse" : { "type" : "object", "properties" : { "recordsFound" : { "type" : "integer", "description" : "Total count of quotes retrieved in the request response." }, "pageSize" : { "type" : "integer", "description" : "Number of records (quotes) displayed per page in the quote list." }, "pageNumber" : { "type" : "integer", "description" : "Page index or page number for the list of quotes being returned." }, "invoices" : { "type" : "array", "description" : "The Invoices details for the requested criteria.", "items" : { "properties" : { "paymentTermsDueDate" : { "type" : "string", "description" : "Payment Terms Due date." }, "erpOrderNumber" : { "type" : "string", "description" : "Order number" }, "invoiceNumber" : { "type" : "string", "description" : "Invoice no." }, "invoiceStatus" : { "type" : "string", "description" : "Invoice Status." }, "invoiceDate" : { "type" : "string", "description" : "Invoice Date." }, "invoiceDueDate" : { "type" : "string", "description" : "Invoice Due Date." }, "invoicedAmountDue" : { "type" : "string", "description" : "Invoice Amount." }, "customerOrderNumber" : { "type" : "string", "description" : "Customer Order No." }, "orderCreateDate" : { "type" : "string", "description" : "Order Create Date." }, "endCustomerOrderNumber" : { "type" : "string", "description" : "End Customer Order number." }, "invoiceAmountInclTax" : { "type" : "string", "description" : "Invoice Amount Inclusive of Taxes" } } } }, "nextPage" : { "type" : "string", "description" : "Next page of the pagination." } } }, "InvoiceDetailResponse" : { "title" : "invoiceDetails.Response", "type" : "object", "x-tags" : [ "invoices" ], "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string" }, "statuscode" : { "type" : "string" }, "responsemessage" : { "type" : "string" } } }, "invoicedetailresponse" : { "type" : "object", "properties" : { "customernumber" : { "type" : "string" }, "invoicenumber" : { "type" : "string" }, "invoicedate" : { "type" : "string", "format" : "date" }, "invoicetype" : { "type" : "string" }, "customerordernumber" : { "type" : "string" }, "customerfreightamount" : { "type" : "string", "format" : "double" }, "customerforeignfrightamt" : { "type" : "string", "format" : "float" }, "totaltaxamount" : { "type" : "string", "format" : "double" }, "totalamount" : { "type" : "string", "format" : "double" }, "shiptosuffix" : { "type" : "string" }, "billtosuffix" : { "type" : "string" }, "freightamount" : { "type" : "string", "format" : "double", "description" : "May not be available in all countries" }, "paymentterms" : { "type" : "string" }, "orderdate" : { "type" : "string", "format" : "date" }, "carrier" : { "type" : "string" }, "carrierdescription" : { "type" : "string" }, "discountamount" : { "type" : "number", "format" : "double" }, "taxtype" : { "type" : "string" }, "enduserponumber" : { "type" : "string" }, "freightforwardercode" : { "type" : "string" }, "creditmemoreasoncode" : { "type" : "string" }, "fulfillmentflag" : { "type" : "string" }, "holdreason" : { "type" : "string" }, "shipcomplete" : { "type" : "string" }, "shipdate" : { "type" : "string", "format" : "date" }, "companycurrency" : { "type" : "string" }, "currencycode" : { "type" : "string" }, "currencyrate" : { "type" : "string" }, "globalorderid" : { "type" : "string" }, "originalshipcode" : { "type" : "string" }, "ordertype" : { "type" : "string" }, "orderstatus" : { "type" : "string" }, "totalotherfees" : { "type" : "number" }, "totalsales" : { "type" : "string" }, "weight" : { "type" : "string" }, "shippableswitch" : { "type" : "string" }, "soldto" : { "$ref" : "#/components/schemas/addressType" }, "billto" : { "$ref" : "#/components/schemas/addressType" }, "shoptoaddress" : { "$ref" : "#/components/schemas/addressType" }, "lines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/productLineType" } }, "extendedspecs" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributename" : { "type" : "string" }, "attributevalue" : { "type" : "string" } } } }, "miscfeeline" : { "type" : "array", "items" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "description" : { "type" : "string" }, "chargeamount" : { "type" : "string" } } } } } } } } } }, "InvoiceDetailsv6.1Response" : { "title" : "invoiceDetailsv6.1Response", "type" : "object", "x-tags" : [ "invoices" ], "properties" : { "invoiceNumber" : { "type" : "string", "description" : "The Invoice number for the order." }, "invoiceStatus" : { "type" : "string", "description" : "Status of the invoice." }, "invoiceDate" : { "type" : "string", "format" : "date", "description" : "Date of an Invoice." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's order number for reference in their system." }, "endCustomerOrderNumber" : { "type" : "string", "description" : "The end customer's order number for reference in their system." }, "OrderDate" : { "type" : "string", "format" : "date", "description" : "The date and time in UTC format that the order was created." }, "billToID" : { "type" : "string", "description" : "Bill to party" }, "invoiceType" : { "type" : "string", "description" : "Type of the Invoice" }, "invoiceDueDate" : { "type" : "string", "description" : "Date when the invoice is due." }, "customerCountryCode" : { "type" : "string", "description" : "Customer country code." }, "customerNumber" : { "type" : "string", "description" : "Unique customer number in Ingram's system." }, "ingramOrderNumber" : { "type" : "string", "description" : "The IngramMicro sales order number." }, "notes" : { "type" : "string", "description" : "Notes for the invoice." }, "paymentTermsInfo" : { "type" : "object", "description" : "Payment terms is the agreement between Ingram and the customer by what period they should pay the invoice by", "properties" : { "paymentTermsCode" : { "type" : "string", "description" : "Code of the payment terms." }, "paymentTermsDescription" : { "type" : "string", "description" : "Description of the payment terms." }, "paymentTermsDueDate" : { "type" : "string", "description" : "Due date of the payment terms." } }, "additionalProperties" : false }, "billToInfo" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "Bill to Name." }, "companyName" : { "type" : "string", "description" : "Bill to company." }, "addressLine1" : { "type" : "string", "description" : "Bill to Address Line1." }, "addressLine2" : { "type" : "string", "description" : "Bill to Address Line2." }, "city" : { "type" : "string", "description" : "Bill to City." }, "state" : { "type" : "string", "description" : "Bill to State code" }, "postalCode" : { "type" : "string", "description" : "Bill to Postalcode code." }, "countryCode" : { "type" : "string", "description" : "Bill to Country code." }, "phoneNumber" : { "type" : "string", "description" : "Phone number of the bill to company." }, "email" : { "type" : "string", "description" : "Email address of the bill to company." } }, "additionalProperties" : false }, "shipToInfo" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "Ship to Name." }, "companyName" : { "type" : "string", "description" : "Ship to company." }, "addressLine1" : { "type" : "string", "description" : "Ship to Address Line1." }, "addressLine2" : { "type" : "string", "description" : "Ship to Address Line2." }, "city" : { "type" : "string", "description" : "Ship to City." }, "state" : { "type" : "string", "description" : "Ship to State code" }, "postalCode" : { "type" : "string", "description" : "Ship to Postalcode code." }, "countryCode" : { "type" : "string", "description" : "Ship to Country code." }, "phoneNumber" : { "type" : "string", "description" : "Phone number of the Ship to company." }, "email" : { "type" : "string", "description" : "Email address of the Ship to company." } }, "additionalProperties" : false }, "lines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ingramLineNumber" : { "type" : "string", "description" : "Unique line number from Ingram." }, "customerLineNumber" : { "type" : "string", "default" : "0", "description" : "Line number passes by customer while creating an order." }, "ingramPartNumber" : { "type" : "string", "description" : "Ingram Micro SKU (stock keeping unit). An identification, usually alphanumeric, of a particular product that allows it to be tracked for inventory purposes." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor Part Number." }, "customerPartNumber" : { "type" : "string", "description" : "Part number from customer's system." }, "vendorName" : { "type" : "string", "description" : "Name of the vendor." }, "productDescription" : { "type" : "string", "description" : "Description of the product." }, "unitWeight" : { "type" : "string", "description" : "Weight of the product." }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity of the product." }, "unitPrice" : { "type" : "number", "format" : "double", "description" : "Unit price of the product." }, "unitOfMeasure" : { "type" : "string", "description" : "Unit of measure of the product." }, "currencyCode" : { "type" : "string", "description" : "Currency code." }, "extendedPrice" : { "type" : "number", "format" : "double", "description" : "Extended price of the product." }, "taxPercentage" : { "type" : "number", "format" : "double", "description" : "Tax percentage" }, "taxRate" : { "type" : "number", "format" : "double", "description" : "Tax rate" }, "taxAmount" : { "type" : "number", "format" : "double", "description" : "Line level tax amount." }, "serialNumbers" : { "type" : "array", "items" : { "type" : "object", "properties" : { "serialNumber" : { "type" : "string", "nullable" : true, "description" : "Serial number of the product." } }, "additionalProperties" : false }, "nullable" : true }, "quantityOrdered" : { "type" : "integer", "format" : "int32", "description" : "Quantity ordered by the customer." }, "quantityShipped" : { "type" : "integer", "format" : "int32", "description" : "Quantity shipped to the customer." } }, "additionalProperties" : false } }, "fxRateInfo" : { "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "Currency code." }, "companyCurrency" : { "type" : "string", "description" : "Company currency code." }, "invoiceCurrency" : { "type" : "string", "description" : "Invoice currency." }, "currencyFxRate" : { "type" : "number", "format" : "double", "description" : "Currency FX rate." } }, "additionalProperties" : false }, "summary" : { "type" : "object", "properties" : { "lines" : { "type" : "object", "properties" : { "productLineCount" : { "type" : "integer", "format" : "int32", "description" : "Number of lines in the order." }, "productLineTotalQuantity" : { "type" : "integer", "format" : "int32", "description" : "Total quantity of the order." } }, "additionalProperties" : false }, "miscCharges" : { "type" : "array", "description" : "Miscellaneous charges.", "items" : { "type" : "object", "properties" : { "chargeDescription" : { "type" : "string", "description" : "Description of the charge." }, "miscChargeLineCount" : { "type" : "integer", "format" : "int32", "description" : "The number of lines for which miscellaneous charges are applicable." }, "miscChargeLineTotal" : { "type" : "number", "format" : "double", "description" : "Miscellaneous charge amount." }, "chargeLineReference" : { "type" : "string", "description" : "Reference of the chargeLine." }, "isNonMisc" : { "type" : "string", "description" : "Is charge non miscellaneous." } }, "additionalProperties" : false }, "nullable" : true }, "totals" : { "type" : "object", "properties" : { "netInvoiceAmount" : { "type" : "number", "format" : "double", "description" : "Net Invoice amount." }, "discountAmount" : { "type" : "number", "format" : "double", "description" : "Discount amount." }, "discountType" : { "type" : "string", "description" : "Type of discount." }, "totalTaxAmount" : { "type" : "number", "format" : "double", "description" : "Total Tax amount." }, "invoicedAmountDue" : { "type" : "number", "format" : "double", "description" : "Total amount due for the invoice." }, "freightAmount" : { "type" : "number", "format" : "double", "description" : "Freight amount" } }, "additionalProperties" : false }, "foreignFxTotals" : { "type" : "object", "properties" : { "foreignCurrencyCode" : { "type" : "string", "description" : "Foreign Currency Code." }, "foreignCurrencyFxRate" : { "type" : "number", "format" : "double", "description" : "Foreign rate." }, "foreignTotalTaxableAmount" : { "type" : "string", "description" : "Foreign amount." }, "foreignTotalTaxAmount" : { "type" : "number", "format" : "double", "description" : "Foreign amount." }, "foreignInvoiceAmountDue" : { "type" : "string", "description" : "Foreign due." } }, "additionalProperties" : false } }, "additionalProperties" : false } } }, "Invoice.PaymentTermsInfoDto" : { "type" : "object", "properties" : { "paymentTermsCode" : { "type" : "string", "description" : "Code of the payment terms." }, "paymentTermsDescription" : { "type" : "string", "description" : "Description of the payment terms." }, "paymentTermsDueDate" : { "type" : "string", "description" : "Due date of the payment terms." } }, "additionalProperties" : false }, "Invoice.BillAddressDto" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "Bill to Name." }, "companyName" : { "type" : "string", "description" : "Bill to company." }, "addressLine1" : { "type" : "string", "description" : "Bill to Address Line1." }, "addressLine2" : { "type" : "string", "description" : "Bill to Address Line2." }, "city" : { "type" : "string", "description" : "Bill to City." }, "state" : { "type" : "string", "description" : "Bill to State code" }, "postalCode" : { "type" : "string", "description" : "Bill to Postalcode code." }, "countryCode" : { "type" : "string", "description" : "Bill to Country code." }, "phoneNumber" : { "type" : "string", "description" : "Phone number of the bill to company." }, "email" : { "type" : "string", "description" : "Email address of the bill to company." } }, "additionalProperties" : false }, "Invoice.ShipAddressDto" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "Ship to Name." }, "companyName" : { "type" : "string", "description" : "Ship to company." }, "addressLine1" : { "type" : "string", "description" : "Ship to Address Line1." }, "addressLine2" : { "type" : "string", "description" : "Ship to Address Line2." }, "city" : { "type" : "string", "description" : "Ship to City." }, "state" : { "type" : "string", "description" : "Ship to State code" }, "postalCode" : { "type" : "string", "description" : "Ship to Postalcode code." }, "countryCode" : { "type" : "string", "description" : "Ship to Country code." }, "phoneNumber" : { "type" : "string", "description" : "Phone number of the Ship to company." }, "email" : { "type" : "string", "description" : "Email address of the Ship to company." } }, "additionalProperties" : false }, "Invoice.LineResponseDto" : { "type" : "object", "properties" : { "ingramLineNumber" : { "type" : "string", "description" : "Unique line number from Ingram." }, "customerLineNumber" : { "type" : "string", "default" : "0", "description" : "Line number passes by customer while creating an order." }, "ingramPartNumber" : { "type" : "string", "description" : "Ingram Micro SKU (stock keeping unit). An identification, usually alphanumeric, of a particular product that allows it to be tracked for inventory purposes." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor Part Number." }, "customerPartNumber" : { "type" : "string", "description" : "Part number from customer's system." }, "vendorName" : { "type" : "string", "description" : "Name of the vendor." }, "productDescription" : { "type" : "string", "description" : "Description of the product." }, "unitWeight" : { "type" : "string", "description" : "Weight of the product." }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity of the product." }, "unitPrice" : { "type" : "number", "format" : "double", "description" : "Unit price of the product." }, "unitOfMeasure" : { "type" : "string", "description" : "Unit of measure of the product." }, "currencyCode" : { "type" : "string", "description" : "Currency code." }, "extendedPrice" : { "type" : "number", "format" : "double", "description" : "Extended price of the product." }, "taxPercentage" : { "type" : "number", "format" : "double", "description" : "Tax percentage" }, "taxRate" : { "type" : "number", "format" : "double", "description" : "Tax rate" }, "taxAmount" : { "type" : "number", "format" : "double", "description" : "Line level tax amount." }, "serialNumbers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Invoice.SerialNumberDto" }, "nullable" : true }, "quantityOrdered" : { "type" : "integer", "format" : "int32", "description" : "Quantity ordered by the customer." }, "quantityShipped" : { "type" : "integer", "format" : "int32", "description" : "Quantity shipped to the customer." } }, "additionalProperties" : false }, "Invoice.RemittanceAddressDto" : { "type" : "object", "properties" : { "addressLine1" : { "type" : "string", "default" : "", "nullable" : true }, "addressLine2" : { "type" : "string", "default" : "", "nullable" : true } }, "additionalProperties" : false }, "Invoice.FxRateInfoDto" : { "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "Currency code." }, "companyCurrency" : { "type" : "string", "description" : "Company currency code." }, "invoiceCurrency" : { "type" : "string", "description" : "Invoice currency." }, "currencyFxRate" : { "type" : "number", "format" : "double", "description" : "Currency FX rate." } }, "additionalProperties" : false }, "Invoice.TaxExemptInfoDto" : { "type" : "object", "properties" : { "exemptName" : { "type" : "string", "default" : "", "nullable" : true }, "exemptValue" : { "type" : "string", "default" : "", "nullable" : true } }, "additionalProperties" : false }, "Invoice.SummaryDto" : { "type" : "object", "properties" : { "lines" : { "$ref" : "#/components/schemas/Invoice.LinesDto" }, "miscCharges" : { "type" : "array", "description" : "Miscellaneous charges.", "items" : { "$ref" : "#/components/schemas/Invoice.MiscChargesDto" }, "nullable" : true }, "totals" : { "$ref" : "#/components/schemas/Invoice.TotalsDto" }, "foreignFxTotals" : { "$ref" : "#/components/schemas/Invoice.ForeignFxTotalsDto" } }, "additionalProperties" : false }, "Invoice.SerialNumberDto" : { "type" : "object", "properties" : { "serialNumber" : { "type" : "string", "nullable" : true, "description" : "Serial number of the product." } }, "additionalProperties" : false }, "Invoice.LineFeeDto" : { "type" : "object", "properties" : { "quantity" : { "type" : "integer", "format" : "int32" }, "feeChargeCode" : { "type" : "string", "default" : "", "nullable" : true }, "feeDescription" : { "type" : "string", "default" : "", "nullable" : true }, "feePerUnit" : { "type" : "string", "default" : "", "nullable" : true }, "totalFeeAmount" : { "type" : "number", "format" : "double", "nullable" : true }, "totalFeeTaxRate" : { "type" : "number", "format" : "double", "nullable" : true }, "totalFeeTaxAmount" : { "type" : "number", "format" : "double", "nullable" : true }, "chargePerUnit" : { "type" : "string", "default" : "", "nullable" : true } }, "additionalProperties" : false }, "Invoice.LinesDto" : { "type" : "object", "properties" : { "productLineCount" : { "type" : "integer", "format" : "int32", "description" : "Number of lines in the order." }, "productLineTotalQuantity" : { "type" : "integer", "format" : "int32", "description" : "Total quantity of the order." } }, "additionalProperties" : false }, "Invoice.MiscChargesDto" : { "type" : "object", "properties" : { "chargeDescription" : { "type" : "string", "description" : "Description of the charge." }, "miscChargeLineCount" : { "type" : "integer", "format" : "int32", "description" : "The number of lines for which miscellaneous charges are applicable." }, "miscChargeLineTotal" : { "type" : "number", "format" : "double", "description" : "Miscellaneous charge amount." }, "chargeLineReference" : { "type" : "string", "description" : "Reference of the chargeLine." }, "isNonMisc" : { "type" : "string", "description" : "Is charge non miscellaneous." } }, "additionalProperties" : false }, "Invoice.TotalsDto" : { "type" : "object", "properties" : { "netInvoiceAmount" : { "type" : "number", "format" : "double", "description" : "Net Invoice amount." }, "discountAmount" : { "type" : "number", "format" : "double", "description" : "Discount amount." }, "discountType" : { "type" : "string", "description" : "Type of discount." }, "totalTaxAmount" : { "type" : "number", "format" : "double", "description" : "Total Tax amount." }, "invoicedAmountDue" : { "type" : "number", "format" : "double", "description" : "Total amount due for the invoice." }, "freightAmount" : { "type" : "number", "format" : "double", "description" : "Freight amount" } }, "additionalProperties" : false }, "Invoice.ForeignFxTotalsDto" : { "type" : "object", "properties" : { "foreignCurrencyCode" : { "type" : "string", "description" : "Foreign Currency Code." }, "foreignCurrencyFxRate" : { "type" : "number", "format" : "double", "description" : "Foreign rate." }, "foreignTotalTaxableAmount" : { "type" : "string", "description" : "Foreign amount." }, "foreignTotalTaxAmount" : { "type" : "number", "format" : "double", "description" : "Foreign amount." }, "foreignInvoiceAmountDue" : { "type" : "string", "description" : "Foreign due." } }, "additionalProperties" : false }, "invoiceDetails" : { "title" : "invoiceDetails.Response", "type" : "object", "x-tags" : [ "invoices" ], "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string" }, "statuscode" : { "type" : "string" }, "responsemessage" : { "type" : "string" } } }, "invoicedetailresponse" : { "type" : "object", "properties" : { "customernumber" : { "type" : "string" }, "invoicenumber" : { "type" : "string" }, "invoicedate" : { "type" : "string", "format" : "date" }, "invoicetype" : { "type" : "string" }, "customerordernumber" : { "type" : "string" }, "customerfreightamount" : { "type" : "string", "format" : "double" }, "customerforeignfrightamt" : { "type" : "string", "format" : "float" }, "totaltaxamount" : { "type" : "string", "format" : "double" }, "totalamount" : { "type" : "string", "format" : "double" }, "shiptosuffix" : { "type" : "string" }, "billtosuffix" : { "type" : "string" }, "freightamount" : { "type" : "string", "format" : "double", "description" : "May not be available in all countries" }, "paymentterms" : { "type" : "string" }, "orderdate" : { "type" : "string", "format" : "date" }, "carrier" : { "type" : "string" }, "carrierdescription" : { "type" : "string" }, "discountamount" : { "type" : "number", "format" : "double" }, "taxtype" : { "type" : "string" }, "enduserponumber" : { "type" : "string" }, "freightforwardercode" : { "type" : "string" }, "creditmemoreasoncode" : { "type" : "string" }, "fulfillmentflag" : { "type" : "string" }, "holdreason" : { "type" : "string" }, "shipcomplete" : { "type" : "string" }, "shipdate" : { "type" : "string", "format" : "date" }, "companycurrency" : { "type" : "string" }, "currencycode" : { "type" : "string" }, "currencyrate" : { "type" : "string" }, "globalorderid" : { "type" : "string" }, "originalshipcode" : { "type" : "string" }, "ordertype" : { "type" : "string" }, "orderstatus" : { "type" : "string" }, "totalotherfees" : { "type" : "number" }, "totalsales" : { "type" : "string" }, "weight" : { "type" : "string" }, "shippableswitch" : { "type" : "string" }, "soldto" : { "$ref" : "#/components/schemas/addressType" }, "billto" : { "$ref" : "#/components/schemas/addressType" }, "shoptoaddress" : { "$ref" : "#/components/schemas/addressType" }, "lines" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/productLineType" } }, "extendedspecs" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributename" : { "type" : "string" }, "attributevalue" : { "type" : "string" } } } }, "miscfeeline" : { "type" : "array", "items" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "description" : { "type" : "string" }, "chargeamount" : { "type" : "string" } } } } } } } } } }, "addressType" : { "title" : "invoiceDetails.addressType.Response", "type" : "object", "properties" : { "attention" : { "type" : "string" }, "addressline1" : { "type" : "string" }, "addressline2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" }, "fax" : { "type" : "string" }, "phonenumber" : { "type" : "string" }, "email" : { "type" : "string" } }, "description" : "Address type object", "x-tags" : [ "invoices" ] }, "productLineType" : { "title" : "invoiceDetails.productLineType.Response", "type" : "object", "description" : "Product line items object under each invoice", "x-tags" : [ "invoices" ], "properties" : { "linenumber" : { "type" : "string" }, "linetype" : { "type" : "string" }, "partnumber" : { "type" : "string" }, "vendorpartnumber" : { "type" : "string" }, "partdescription" : { "type" : "string" }, "shipfrombranch" : { "type" : "string" }, "shippedquantity" : { "type" : "string" }, "orderedquantity" : { "type" : "string" }, "marginpercent" : { "type" : "string" }, "backorderquantity" : { "type" : "string" }, "backorderetadate" : { "type" : "string", "format" : "date" }, "extendedprice" : { "type" : "string" }, "specialbidnumber" : { "type" : "string" }, "ordersuffix" : { "type" : "string" }, "isacopapplied" : { "type" : "string" }, "unitprice" : { "type" : "string" }, "unitofmeasure" : { "type" : "string" }, "serialnumberdetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "serialnumber" : { "type" : "string" }, "deliverynumber" : { "type" : "string" } } } }, "trackingnumberdetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "trackingnumber" : { "type" : "string" } } } }, "productextendedspecs" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributename" : { "type" : "string" }, "attributevalue" : { "type" : "string" } } } } } }, "ErrorResponse" : { "type" : "object", "properties" : { "errors" : { "type" : "array", "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." }, "value" : { "type" : "string", "description" : "Value sent in the input for the specific field." }, "message" : { "type" : "string", "description" : "Gives the description of the field message." } } } } } } } } }, "orderCreateRequest" : { "title" : "orderCreate.Request", "type" : "object", "x-examples" : { }, "x-tags" : [ "orders" ], "description" : "Request schema for order create endpoint", "properties" : { "ordercreaterequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "required" : [ "isocountrycode", "customernumber" ], "properties" : { "isocountrycode" : { "type" : "string", "description" : "2 digit ISO country code" }, "customernumber" : { "type" : "string", "description" : "Your unique Ingram Micro customer number", "example" : "10-123456 or 123456" } } }, "ordercreatedetails" : { "type" : "object", "properties" : { "customerponumber" : { "type" : "string", "minLength" : 1, "maxLength" : 18, "description" : "The customers unique Purchase Order number. Keep it unique to retrieve order information" }, "ordertype" : { "type" : "string", "enum" : [ "Standard", "Direct Ship" ], "description" : "Order Type - Standard orders, Direct ship orders" }, "enduserordernumber" : { "type" : "string", "description" : "Customers End-user PO number", "minLength" : 0, "maxLength" : 18 }, "billtosuffix" : { "type" : "string", "description" : "Designates flooring acct to be used", "maxLength" : 3 }, "shiptosuffix" : { "type" : "string", "description" : "Applies to customers with multiple ship to locations (store locations)", "maxLength" : 3 }, "shiptoaddress" : { "type" : "object", "required" : [ "addressline1", "addressline2", "city", "state", "postalcode" ], "properties" : { "attention" : { "type" : "string", "description" : "Customer contact name", "example" : "“Mr. Customer”", "maxLength" : 35 }, "addressline1" : { "type" : "string", "description" : "Company Name or person to deliver.\n*If there isn’t an attention line please add the company name on address line 1. UPS and FedEx will create surcharges if address line 1 contains a physical address.", "example" : "“Ingram Micro”", "maxLength" : 35 }, "addressline2" : { "type" : "string", "description" : "Street address for delivery", "example" : "3351 Michelson Dr", "maxLength" : 35 }, "city" : { "type" : "string", "example" : "Irvine", "maxLength" : 21, "description" : "Ship to city" }, "state" : { "type" : "string", "example" : "CA", "maxLength" : 2, "description" : "Ship to State or Region" }, "postalcode" : { "type" : "string", "description" : "Ship to Zip code or Postal code", "example" : "92712", "maxLength" : 9 }, "countrycode" : { "type" : "string", "description" : "Ship to country", "example" : "US", "maxLength" : 2 } } }, "carriercode" : { "type" : "string", "description" : "A customer can dictate what carrier to use for their shipment (Ingram 2-digit carrier code is required). Our recommendation is leave this field blank which will allow Ingram Micro to choose the best carrier to gain the best freight rates.", "maxLength" : 2 }, "thirdpartyfreightaccountnumber" : { "type" : "string", "description" : "Refers to a third-party freight account number for charging freight against. The account number should be passed within this field and the appropriate carrier code should be supplied within the carrier code tags. Prior to sending your request containing the third-party account number, it must be first entered into our system. Your Ingram Micro Sales Representative can action this for you. If submitted within an order without this preapproval the third-party account number will be ignored.\n\nNote: USA partners- For FedEx Air only (carrier codes F1, FO, F2, FG.), please send three leading zeros before your third-party freight account number (i.e.: 000999999999.) " }, "specialbidnumber" : { "type" : "string", "description" : "This is the special quote number given to a customer either by a vendor for special pricing or by Ingram Micro. To receive the special pricing assigned to this number it must be included on the order." }, "lines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "linetype" : { "type" : "string", "description" : "Values are “P” for product or “C” for comments. This can be left blank when ordering product and a “P” will be assumed. If you are adding a COMMENT, then this value must be “C”.\n\nExtended spec for comments: \nAttribute Name: “commenttext”\nAttribute Value: “thank you for the order” \nTo make the comment invisible to the packing slip place “///” in front of the comment in the Attribute Value field. This will allow the Ingram sales rep to see the comment on the order but will not forward on to shipping documents.", "enum" : [ "P", "C" ] }, "linenumber" : { "type" : "string", "description" : "This is used when a partner wants to use their own line number. Can be left blank." }, "ingrampartnumber" : { "type" : "string", "description" : "This is the Ingram sku number to be used for placing an order." }, "quantity" : { "type" : "string", "description" : "The quantity that is to be ordered." }, "vendorpartnumber" : { "type" : "string", "description" : "The Manufacturer part number. Can be used to place an order instead of the Ingram sku. If there are multiple Ingram part numbers to one vendor part number. The order will be rejected." }, "customerpartnumber" : { "type" : "string", "description" : "This is the Customers unique part numbers that must be crossed referenced to the Ingram Micro Sku before it can be used. Please contact your sales rep for additional information on how to set this up." }, "UPCCode" : { "type" : "string" }, "warehouseid" : { "type" : "string" }, "unitprice" : { "type" : "string", "description" : "This is a requested price from the customer. Pre-approval is necessary before using this feature. A methodology called price variance to manage requested pricing needs to be setup in advance by your sales rep.\n\nIf unit price is provided without this advanced setup the unit price will be ignored and standard Ingram Micro pricing will apply." }, "enduser" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "addressline1" : { "type" : "string" }, "addressline2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" }, "phonenumber" : { "type" : "string" }, "extensionnumber" : { "type" : "string" }, "faxnumber" : { "type" : "string" }, "email" : { "type" : "string", "format" : "email" } } }, "productextendedspecs" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributename" : { "type" : "string", "enum" : [ "shipfrom", "specialprice", "authbidnumber", "commenttext", "serialnumber", "contactnumber", "shipnotestxt" ] }, "attributevalue" : { "type" : "string" } } } } }, "required" : [ "quantity" ] } }, "extendedspecs" : { "type" : "array", "items" : { "type" : "object", "description" : "Attribute Name and Value: This field identifies if your order is a DIRECT SHIP order (license / warranty) or how you want your Backorders managed as well as other process options like placing your order on hold or adding a comment. ", "properties" : { "attributename" : { "type" : "string", "enum" : [ "Isdirectshiporder", "emailaddress", "Isbackorderflagallowed", "placeoncustomerhold", "signaturerequired", "commenttext", "resellerctacemail", "duplicatecustomerordernumbervalidate", "quotenumber", "shipctacphone", "vendauthnumber", "continueonerror" ] }, "attributevalue" : { "type" : "string" } } } } }, "required" : [ "customerponumber", "ordertype", "shiptoaddress", "lines" ] } }, "required" : [ "requestpreamble" ] } } }, "orderCreateResponse" : { "title" : "orderCreate.Response", "type" : "object", "x-tags" : [ "orders" ], "description" : "Response schema for order create endpoint", "x-examples" : { }, "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string" }, "statuscode" : { "type" : "string" }, "responsemessage" : { "type" : "string" } } }, "ordersummary" : { "type" : "object", "properties" : { "customerponumber" : { "type" : "string" }, "totalorderamount" : { "type" : "string", "description" : "Total of all the orders including taxes and fees" }, "totalordercreated" : { "type" : "string", "description" : "Number of orders created, in some cases we may create more than one order." }, "shiptoaddress" : { "type" : "object", "properties" : { "attention" : { "type" : "string" }, "name" : { "type" : "string" }, "addressline1" : { "type" : "string" }, "addressline2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" } } } } }, "ordercreateresponse" : { "type" : "array", "description" : "Collection of orders", "items" : { "type" : "object", "properties" : { "numberoflineswithsuccess" : { "type" : "string", "description" : "Number of line items that were successful" }, "numberoflineswitherror" : { "type" : "string", "description" : "Number of line items with error" }, "numberoflineswithwarning" : { "type" : "string", "description" : "Number of line items with warnings" }, "globalorderid" : { "type" : "string", "description" : "Ingram sales order number" }, "ordertype" : { "type" : "string", "description" : "S=Stocked PO D=Direct Ship PO", "enum" : [ "S", "D" ] }, "ordertimestamp" : { "type" : "string", "description" : "Time order received" }, "invoicingsystemorderid" : { "type" : "string", "description" : "Ingram Micro generated order number" }, "taxamount" : { "type" : "number" }, "freightamount" : { "type" : "number", "description" : "Freight amount customer pays for freight" }, "orderamount" : { "type" : "number", "description" : "Total amount of order with freight and taxes" }, "Lines" : { "type" : "array", "description" : "Collection of lines", "items" : { "type" : "object", "properties" : { "linetype" : { "type" : "string", "description" : "“P”-Line or SKU Number “C”-Comment Line" }, "globallinenumber" : { "type" : "string", "description" : "Ingram generated line number" }, "partnumber" : { "type" : "string", "description" : "Ingram Micro Sku Number" }, "globalskuid" : { "type" : "string" }, "linenumber" : { "type" : "string" }, "carriercode" : { "type" : "string", "description" : "Transportation 2 digit codes" }, "carrierdescription" : { "type" : "string", "description" : "Transportation Carrier Name" }, "requestedunitprice" : { "type" : "number", "description" : "Price requested by reseller. Price Variance can be set up by Ingram Micro Sales Rep" }, "requestedquantity" : { "type" : "integer", "description" : "Quanity Requested" }, "confirmedquantity" : { "type" : "integer", "description" : "Quanity Shipped" }, "backorderedquantity" : { "type" : "integer", "description" : "Quanity of units that didn’t ship" }, "unitproductprice" : { "type" : "number", "description" : "Price Per Unit" }, "netamount" : { "type" : "number", "description" : "Total amount. Quantity X Unit Price" }, "warehouseid" : { "type" : "string" }, "ordersuffix" : { "type" : "string", "description" : "Use order suffix with the globalorderid for this line item." } } } } } } } } } } }, "orderDetailResponse" : { "title" : "orderDetail.Response", "type" : "object", "x-tags" : [ "orders" ], "description" : "Response schema for order details endpoint", "x-examples" : { "Example" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "orderdetailresponse" : { "ordernumber" : "10-12345", "customerordernumber" : "test order", "enduserponumber" : "ABC", "orderstatus" : "INVOICED", "entrytimestamp" : "2018-07-15T04:31:42-07:00", "entrymethoddescription" : "XML/PCG", "fulfilmentordercode" : "Y", "ordertotalvalue" : 3907.38, "ordersubtotal" : 3907.38, "freightamount" : 141.34, "currencycode" : "USD", "totalweight" : "86", "totaltax" : "0", "billtoaddress" : { "suffix" : "000", "name" : "Ingram Micro", "addressline1" : "123 Ingram Way", "addressline2" : null, "city" : "Irvine", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "shiptoaddress" : { "name" : "Mr Customer", "addressline1" : "123 Main St", "city" : "Anywhere", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "lines" : [ { "globallinenumber" : "001", "ordersuffix" : "11", "linestatus" : "INVOICED", "partnumber" : "3AM612", "manufacturerpartnumber" : "QN75Q8FNBFXZA", "vendorname" : "SAMSUNG - CONSUMER TV", "partdescription1" : "75IN Q8 FLAT 4K UHD HDR SMARTTV", "partdescription2" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE", "freeitempromoflag" : "false", "unitweight" : "75", "unitprice" : 50000.48, "foreignunitprice" : 0, "extendedprice" : 5000.48, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-16", "shipfromwarehouseid" : "40", "warehousename" : "Carol Stream, IL", "invoicenumber" : "1234511", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-16", "carriercode" : "AY", "carriername" : "ORD4708752", "packagedetails" : { "trackingnumber" : 6838019, "packageweight" : 80, "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-11", "vendorcode" : "Q012", "isacopapplied" : "N", "adjustedcost" : "5000.09", "serialnumberdetails" : { "serialnumber" : "07AS3CAK500682" }, "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE" } }, { "globallinenumber" : "002", "ordersuffix" : "21", "linestatus" : "INVOICED", "partnumber" : "2GH590", "manufacturerpartnumber" : "F-ADT-STR-KT-1", "vendorname" : "SAMSUNG - SMART THINGS", "partdescription1" : "ADT HOME SECURITY STARTER KIT", "partdescription2" : "SECURITY STARTER KIT", "freeitempromoflag" : "false", "unitweight" : "5.15", "unitprice" : 500.9, "foreignunitprice" : 0, "extendedprice" : 500.9, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-17", "shipfromwarehouseid" : "80", "warehousename" : "Jonestown, PA", "invoicenumber" : "1234521", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-17", "carriercode" : "RG", "carriername" : "FEDEX GROUND", "packagedetails" : { "trackingnumber" : "017136225260674", "packageweight" : "000000006", "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-21", "vendorcode" : "QG64", "isacopapplied" : "N", "adjustedcost" : "400.99", "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "SECURITY STARTER KIT" } } ], "extendedspecs" : [ { "attributename" : "termscode", "attributevalue" : "300" }, { "attributename" : "termsdescription", "attributevalue" : "NET 30 DAYS" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" } ], "ordertype" : "S", "erpid" : null } } } }, "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string" }, "statuscode" : { "type" : "string" }, "responsemessage" : { "type" : "string" } } }, "orderdetailresponse" : { "type" : "object", "properties" : { "ordernumber" : { "type" : "string" }, "ordertype" : { "type" : "string", "description" : "Order Type\t\t\nB - BRANCH TRANSFER\nC - CASH ORDER\nD - DIRECT ORDER\nF - FUTURE ORDER\nP - SPECIAL ORDER\nQ - QUOTE ORDER\nS - STOCK ORDER\nM - MEMO ORDER" }, "customerordernumber" : { "type" : "string", "description" : "Customer PO number" }, "enduserponumber" : { "type" : "string", "description" : "End User PO number" }, "orderstatus" : { "type" : "string", "description" : "Status of order within Ingram system\nS - SALES HOLD\nH - TAG HOLD\nI - INVOICED\nP - PENDING\nE - BILLING ERROR\nF - FORCE BILLING\nV - VOIDED\nT - TRANSFERRED\nD - HOLD SHIPMENT\nR - RELEASED\nO - IM ONLINE HOLD\nU - BILL FOR HISTORY ONLY\nW - ORDER NOT PRINTED\nA - DROP SHIP HOLD\nB - INTERNET CUST ORIG HOLD\n1 - PICKED\n2 - INSPECTED\n3 - PACKED\n4 - SHIPPED\nC - CREDIT HOLD\n9 - CISCO 3A6\nQ - RMA HOLD\nG - CREDIT HOLD\nN - CREDIT HOLD" }, "entrytimestamp" : { "type" : "string", "description" : "Time stamp of the order placed" }, "entrymethoddescription" : { "type" : "string", "description" : "Description of the entry method\t" }, "ordertotalvalue" : { "type" : "number", "description" : "Total order value" }, "ordersubtotal" : { "type" : "number", "description" : "Subtotal order value" }, "freightamount" : { "type" : "string", "description" : "Freight charges" }, "currencycode" : { "type" : "string", "description" : "Country specific currency code" }, "totalweight" : { "type" : "string", "description" : "Total order weight. unit -- North america - Pounds , other countries will be KG" }, "totaltax" : { "type" : "string", "description" : "total tax on the orders placed" }, "billtoaddress" : { "type" : "object", "properties" : { "suffix" : { "type" : "string" }, "name" : { "type" : "string" }, "attention" : { "type" : "string" }, "addressline1" : { "type" : "string" }, "addressline2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" } } }, "shiptoaddress" : { "type" : "object", "properties" : { "suffix" : { "type" : "string" }, "attention" : { "type" : "string" }, "name" : { "type" : "string" }, "addressline1" : { "type" : "string" }, "addressline2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" } } }, "enduserinfo" : { "type" : "object", "properties" : { "enduserid" : { "type" : "string" } } }, "lines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "linenumber" : { "type" : "string", "description" : "Impulse line number" }, "globallinenumber" : { "type" : "string", "description" : "Line of the Globel Sku / Customer Line Number" }, "ordersuffix" : { "type" : "string", "description" : "Order Suffix" }, "erpordernumber" : { "type" : "string", "description" : "Sales order number" }, "linestatus" : { "type" : "string", "description" : "Status of the line" }, "partnumber" : { "type" : "string", "description" : "Ingram part number" }, "manufacturerpartnumber" : { "type" : "string", "description" : "manufacture number of the product" }, "vendorname" : { "type" : "string", "description" : "name of the vendor" }, "vendorcode" : { "type" : "string", "description" : "Ingram Micro assigned code for the vendor" }, "partdescription1" : { "type" : "string" }, "partdescription2" : { "type" : "string" }, "unitweight" : { "type" : "string", "description" : "weight of the product unit" }, "unitprice" : { "type" : "number", "description" : "Customer price of the unit" }, "extendedprice" : { "type" : "number", "description" : "extended price of the order" }, "taxamount" : { "type" : "number", "description" : "tax amount for the order" }, "requestedquantity" : { "type" : "string", "description" : "no. of units requested" }, "confirmedquantity" : { "type" : "string", "description" : "no. of units confirmed available" }, "backorderquantity" : { "type" : "string", "description" : "quantity of back order" }, "serialnumberdetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "serialnumber" : { "type" : "string", "description" : "serial number of the ordered SKU" } } } }, "trackingnumber" : { "type" : "array", "items" : { "type" : "string", "description" : "Tracking number of the order. If carriername is LTL then the tracking info is in the \"pronumber\" data field" } }, "shipmentdetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "quantity" : { "type" : "number", "description" : "quantity shipped" }, "shipmentdate" : { "type" : "string", "description" : "date of shipment" }, "shipfromwarehouseid" : { "type" : "string", "description" : "Warehouse product was shipped from" }, "warehousename" : { "type" : "string", "description" : "name of the warehouse" }, "invoicenumber" : { "type" : "string", "description" : "Invoice Number" }, "invoicedate" : { "type" : "string", "description" : "date on the invoice generated" }, "status" : { "type" : "string", "description" : "code for current Status of the order" }, "statusdescription" : { "type" : "string", "description" : "Description of status" }, "shippeddate" : { "type" : "string", "description" : "date of shipment" }, "holdreasoncodedescription" : { "type" : "string", "description" : "Description of the code if the order is on hold" }, "ponumber" : { "type" : "string", "description" : "Ingram PO Number to vendors for direct ship orders" }, "carriertype" : { "type" : "string", "description" : "Helps to determine shipment type. for e.g. LTL is used for heavy shipment. SML is used for light shipment" }, "carriercode" : { "type" : "string", "description" : "" }, "carriername" : { "type" : "string", "description" : "Name of the carrier. If carriername is LTL then the tracking info is in the \"pronumber\" data field" }, "pronumber" : { "type" : "string", "description" : "" }, "packagedetails" : { "type" : "object", "properties" : { "trackingnumber" : { "type" : "string" }, "packageweight" : { "type" : "string" }, "cartonnumber" : { "type" : "string" }, "quantityinbox" : { "type" : "string" } } } } } }, "productextendedspecs" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributename" : { "type" : "string" }, "attributevalue" : { "type" : "string" } } } }, "backorderetadate" : { "type" : "string", "description" : "estimated date of back order" } } } }, "commentlines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "commenttext1" : { "type" : "string" }, "commenttext2" : { "type" : "string" } } } }, "miscfeeline" : { "type" : "array", "items" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Handling charges/Miscellaneous Fee description" }, "chargeamount" : { "type" : "string", "description" : "Handling charges/ Miscelaneous fee amount" } } } }, "extendedspecs" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributename" : { "type" : "string", "description" : "termscode' | 'termsdescription' | 'commenttext' are the atrribute name" }, "attributevalue" : { "type" : "string", "description" : "values of these fields are send . termscode' | 'termsdescription' | 'commenttext' are the atrribute name" } } } } } } } } } }, "orderCancelResponse" : { "title" : "orderCancel.Response", "type" : "object", "x-tags" : [ "orders" ], "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "requestStatus" : { "type" : "string" }, "returnCode" : { "type" : "string" }, "returnMessage" : { "type" : "string" } } } } } }, "description" : "Response schema for order delete endpoint", "x-examples" : { } }, "orderSearchResponse" : { "title" : "orderSearch.Response", "type" : "object", "description" : "Response schema for order search endpoint", "x-tags" : [ "orders" ], "properties" : { "serviceResponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "requeststatus" : { "type" : "string" }, "returnmessage" : { "type" : "string" } }, "required" : [ "requeststatus", "returnmessage" ] }, "ordersearchresponse" : { "type" : "object", "properties" : { "ordersfound" : { "type" : "string", "description" : "Number of records found in the search result" }, "pagesize" : { "type" : "string", "description" : "The submitted pagesize, default is 25" }, "pagenumber" : { "type" : "string", "description" : "The submitted pager number, default is 1" }, "orders" : { "type" : "array", "description" : "An array of orders in the search result", "items" : { "type" : "object", "properties" : { "ordernumber" : { "type" : "string", "description" : "Ingram micro sales order number" }, "entrytimestamp" : { "type" : "string", "description" : "The order creation date-time in UTC format" }, "customerordernumber" : { "type" : "string", "description" : "PO/Order number submitted while creating the order" }, "suborders" : { "type" : "array", "description" : "An order MAY get divided into various sub orders, for example if the SKUs are being shipped from different warehouse.", "items" : { "type" : "object", "properties" : { "subordernumber" : { "type" : "string", "description" : "A sub order number" }, "statuscode" : { "type" : "string", "description" : "Order status code" }, "status" : { "type" : "string", "description" : "Details of the order statuscode - i.e. statuscode = 4 then status = SHIPPED" }, "holdreasoncode" : { "type" : "string", "description" : "Will be returned in case of order on hold" }, "holdreason" : { "type" : "string", "description" : "Reason for order hold - will be returned if the order is on hold" }, "links" : { "type" : "array", "description" : "HATEOAS links for the details and invoices of the sub-orders if available", "items" : { "type" : "object", "properties" : { "topic" : { "type" : "string", "enum" : [ "orders", "invoices" ], "description" : "topic being orders or invoices, if it is orders then the link will provide details of the order. If its invoices then the link provides details of the invoice" }, "href" : { "type" : "string", "format" : "uri", "description" : "The API endpoint for accessing the relevant data" }, "type" : { "type" : "string", "enum" : [ "GET", "POST", "PUT" ], "description" : "The type of call that can be made to the href link" } } } } } } }, "links" : { "type" : "object", "description" : "HATEOAS links for the main order", "properties" : { "topic" : { "type" : "string", "description" : "Topic being orders in this case, if it is orders then the link will provide details of the order.", "enum" : [ "orders", "invoices" ] }, "href" : { "type" : "string", "description" : "The API endpoint for accessing the relevant data", "format" : "uri" }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link", "enum" : [ "GET", "POST", "PUT" ] } } } }, "required" : [ "ordernumber", "entrytimestamp" ] } } }, "required" : [ "ordersfound" ] } } } } }, "productSearchResponse" : { "title" : "productSearch.Response", "type" : "object", "description" : "Response object model for the product search endpoint", "x-tags" : [ "product catalog" ], "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "requeststatus" : { "type" : "string" }, "returncode" : { "type" : "string" }, "returnmessage" : { "type" : "string" } } }, "productsearchresponse" : { "type" : "array", "items" : { "type" : "object", "properties" : { "responseflag" : { "type" : "string", "description" : "Number of records in the search result." }, "partnumbers" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ingrampartnumber" : { "type" : "string", "description" : "Ingram Part Number" }, "manufacturerpartnumber" : { "type" : "string", "description" : "Vendor or Manufacturer Part Number" }, "upccode" : { "type" : "string", "description" : "UPC" }, "productdescription" : { "type" : "string", "description" : "Product description" }, "currency" : { "type" : "string" }, "haswarranty" : { "type" : "string" } } } } } } } } } } }, "priceAndAvailabilityRequest" : { "title" : "priceAndAvailability.Request", "type" : "object", "description" : "Request object model for the multi sku price and stock API endpoint", "x-examples" : { "Example" : { "servicerequest" : { "requestpreamble" : { "customernumber" : "20-222222", "isocountrycode" : "US" }, "priceandstockrequest" : { "showwarehouseavailability" : "True", "extravailabilityflag" : "Y", "item" : [ { "ingrampartnumber" : "M93592", "quantity" : 1 } ], "includeallsystems" : false } } } }, "x-tags" : [ "product catalog" ], "properties" : { "servicerequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "properties" : { "isocountrycode" : { "type" : "string", "description" : "2 Digit ISO country code", "example" : "US", "minLength" : 2, "maxLength" : 2 }, "customernumber" : { "type" : "string", "description" : "Your Ingram Micro customer number", "example" : "12-34567 or 12-345678 or 123456 " } }, "required" : [ "isocountrycode", "customernumber" ] }, "priceandstockrequest" : { "type" : "object", "properties" : { "showwarehouseavailability" : { "type" : "string", "description" : "True/false to show the availability of individual warehouses" }, "extravailabilityflag" : { "type" : "string", "description" : "Y/N to show extra availability flag" }, "includeallsystems" : { "type" : "boolean", "description" : "Flag to indicate if the price and stock information is required for all Ingram Micro systems." }, "item" : { "type" : "array", "items" : { "type" : "object", "properties" : { "index" : { "type" : "integer" }, "ingrampartnumber" : { "type" : "string", "description" : "Ingram Micro SKU number" }, "vendorpartnumber" : { "type" : "string", "description" : "Vendor/Manufacture Part Number" }, "upc" : { "type" : "string", "description" : "Universal Product code" }, "customerpartnumber" : { "type" : "string", "description" : "Unique identoifier for the customer, needs custom setup." }, "warehouseidlist" : { "type" : "array", "description" : "Unique identity for Ingram Micro warehouses against which stock details are returned.", "items" : { "type" : "string" } }, "extendedvendorpartnumber" : { "type" : "string" }, "quantity" : { "type" : "number" }, "enduserid" : { "type" : "string" }, "govtprogramtype" : { "type" : "string" }, "govtendusertype" : { "type" : "string" }, "specialbidnumber" : { "type" : "string" } } } } } } } } } }, "priceAndAvailabilityResponse" : { "title" : "priceAndAvailability.Response", "type" : "object", "x-examples" : { "Success" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS", "statuscode" : "200", "responsemessage" : "Data Found" }, "priceandstockresponse" : { "details" : [ { "itemstatus" : "SUCCESS", "statusmessage" : "A-No qty breaks availa", "ingrampartnumber" : "TB6489", "vendorpartnumber" : "H1180HD", "globalskuid" : "A300-TB6489", "customerprice" : 850.54, "currency" : "USD", "partdescription1" : "H1180HD DLP 3D PROJ 2000L 1080PPROJ", "partdescription2" : "10000:1 VGA HDMI RCA", "vendornumber" : "Q680", "vendorname" : "VIVITEK", "cpucode" : "DLP-PR", "class" : "X", "skustatus" : "ACTIVE", "mediacpu" : "PROJ DLP-PR", "categorysubcategory" : "04 25", "retailprice" : 899, "newmedia" : "PROJ", "backorderflag" : "N", "skuauthorized" : "Y", "warehousedetails" : [ { "warehouseid" : "80", "warehousedescription" : "Jonestown, PA", "availablequantity" : 0, "onorderquantity" : 0 }, { "warehouseid" : "10", "warehousedescription" : "Mira Loma, CA", "availablequantity" : 0, "onorderquantity" : 0 } ] } ] } } }, "Invalid Customer" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "FAILED", "statuscode" : "500", "responsemessage" : "Data Not Found" }, "priceandstockresponse" : { "details" : [ { "itemstatus" : "FAILED", "statusmessage" : "E-INVALID CUSTOMER NUMBER" }, { "itemstatus" : "FAILED", "statusmessage" : "E-INVALID CUSTOMER NUMBER" }, { "itemstatus" : "FAILED", "statusmessage" : "E-INVALID CUSTOMER NUMBER" } ] } } }, "Invalid Country " : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESSWITHERROR", "statuscode" : "046", "responsemessage" : "Partial Data Found" }, "priceandstockresponse" : { "details" : [ { "itemstatus" : "SUCCESS", "statusmessage" : "edv 2", "ingrampartnumber" : "NaN", "vendorpartnumber" : null, "globalskuid" : "A001-NaN", "customernumber" : "41-231791", "quantity" : 0, "customerprice" : 0, "vendornumber" : "NaN", "retailprice" : 0, "enduserrequired" : "false", "specialpromoflag" : "false", "isavailable" : false, "isstocakable" : false, "isbom" : false, "hasquantitybreaks" : false, "haswebdiscounts" : false, "issboprice" : false, "extendednetamount" : 0, "taxamount" : 0, "totalfeeamount" : 0, "totalpromotionamount" : 0, "totalenvironmentalfees" : 0 } ] } } } }, "x-tags" : [ "product catalog" ], "description" : "Response object model for the multi sku price and stock API endpoint", "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string", "description" : "SUCCESS or FAILED, sometimes PARTIAL SUCCESS if connection to 1 of the systems fails" }, "responsemessage" : { "type" : "string", "description" : "Overall status message including error message" }, "statuscode" : { "type" : "string", "description" : "Statuscode Message" } } }, "priceandstockresponse" : { "type" : "object", "properties" : { "details" : { "type" : "array", "items" : { "type" : "object", "properties" : { "itemstatus" : { "type" : "string", "description" : "SUCCESS or FAILED", "enum" : [ "SUCCESS", "FAILED" ] }, "statusmessage" : { "type" : "string", "description" : "Description of itemstatus" }, "ingrampartnumber" : { "type" : "string", "description" : "Ingram Micro part number" }, "vendorpartnumber" : { "type" : "string", "description" : "Manufacturer/Vendor part number" }, "globalskuid" : { "type" : "string" }, "customerprice" : { "type" : "number", "description" : "Customer specific price for the product, excluding taxes" }, "partdescription1" : { "type" : "string", "description" : "Product description part 1" }, "partdescription2" : { "type" : "string", "description" : "Product description part 2" }, "vendornumber" : { "type" : "string" }, "vendorname" : { "type" : "string", "description" : "Name of the vendor" }, "cpucode" : { "type" : "string" }, "class" : { "type" : "string", "description" : "Ingram Micro assigned product classification - \nA-Stocked product in all IM warehouses, B-Limited stock in IM warehouses, C-Stocked in fewer wareshouses, D-Ingram discontinued, E-Planned to be phased out as per the vendor, F-Carried for specific customer as per the contract, N-New SKU, O-Discontinued to be liquidated, S-Order for specialized demand, V-Discontinued by vendor, X-Direct Ship products from vendor", "enum" : [ "A", "B", "C", "D", "E", "F", "N", "O", "S", "V", "X" ] }, "skustatus" : { "type" : "string", "description" : "Identifies if the SKU has been discontinued.", "enum" : [ "ACTIVE" ] }, "mediacpu" : { "type" : "string" }, "categorysubcategory" : { "type" : "string" }, "retailprice" : { "type" : "number" }, "newmedia" : { "type" : "string" }, "enduserrequired" : { "type" : "string", "description" : "Y - End user required N - Not required End user", "enum" : [ "Y", "N" ] }, "backorderflag" : { "type" : "string", "description" : "Y- Allow Backorder Flag N- Not allowed", "enum" : [ "Y", "N" ] }, "skuauthorized" : { "type" : "string" }, "extendedvendorpartnumber" : { "type" : "string" }, "warehousedetails" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/warehouseListType" } } } } } } } } } } }, "warehouseListType" : { "title" : "priceAndAvailability.warehouseListType.Response", "type" : "object", "properties" : { "warehouseid" : { "type" : "string", "description" : "" }, "warehousedescription" : { "type" : "string", "description" : "City of the Ingram Micro warehouse location" }, "availablequantity" : { "type" : "integer", "description" : "On hand available quantity" }, "onorderquantity" : { "type" : "integer", "description" : "On Order quantity" }, "onholdquantity" : { "type" : "integer", "description" : "On hold quantity" }, "etadate" : { "type" : "string" } } }, "quoteListRequest" : { "title" : "quoteList.Request", "type" : "object", "x-examples" : { "Example" : { "quoteSearchRequest" : { "requestPreamble" : { "customerNumber" : "40006990", "customerContact" : "user.name@ingrampartner.com", "isoCountryCode" : "US" }, "retrieveQuoteRequest" : { "quoteNumber" : "QUO-02973-V6H8R6", "bidNumber" : "MDMF-1199371-1811", "endUserName" : "CARESOURCE MANAGEMENT GROUP CO.", "quoteStatus" : "3", "fromDate" : "2019-09-01", "toDate" : "2019-09-11", "pageIndex" : 1, "recordsPerPage" : 25, "sorting" : "desc", "sortingColumnName" : "createdon", "thirdPartySource" : "3RDPIDCONWISE" } } } }, "description" : "Request schema for get quote list endpoint", "x-tags" : [ "quotes" ], "properties" : { "quoteSearchRequest" : { "type" : "object", "properties" : { "requestPreamble" : { "type" : "object", "properties" : { "customerNumber" : { "type" : "string", "description" : "Reseller Number (referred to as the account BCN) is the unique identifier for an Ingram Micro customer account.", "maxLength" : 10 }, "customerContact" : { "type" : "string", "description" : "Logged in User's email address.", "format" : "email" }, "isoCountryCode" : { "type" : "string", "description" : "The ISO country codes are internationally recognized codes designated for each country represented by a two-letter combination (alpha-2).", "maxLength" : 3 } }, "required" : [ "customerNumber", "isoCountryCode" ] }, "retrieveQuoteRequest" : { "type" : "object", "properties" : { "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes.", "maxLength" : 100 }, "bidNumber" : { "type" : "string", "description" : "Special Pricing Bid Number, also referred to as a Dart Number by some vendors, is a unique identifier associated with vendor specific products and discounts.", "maxLength" : 100 }, "endUserName" : { "type" : "string", "description" : "End User Name is the end customer name that is associated with a quote in Ingram Micro's CRM", "maxLength" : 300 }, "fromDate" : { "type" : "string", "description" : "Filter to select the beginning date of a desired date range. The default filter is set to the date the user is logged-in to request quotes. Date format: YYYY-MM-DD - An incorrect date input will result in a message \"Date must be entered as YYYY-MM-DD\"", "format" : "date", "example" : "2019-08-01" }, "toDate" : { "type" : "string", "description" : "Filter to select the end date of a desired date range. The default number of days to request is the previous 30 days from the date user has logged in. Date format: YYYY-MM-DD - An incorrect date input will result in a message \"Date must be entered as YYYY-MM-DD\"", "format" : "date", "example" : "2019-11-01" }, "pageIndex" : { "type" : "string", "description" : "Page index or page number for the list of quotes being returned. When less than 25 quotes are returned, the page number will be \"1\". In cases where more than 25 quotes are returned, and the default quotes per page are 25 (see recordPerPage), then the list will continue on subsequent pages." }, "recordsPerPage" : { "type" : "string", "description" : "Number of records (quotes) to display per page in the quote list. The default is 25, but may be increased using the filter by up to 100 records per page. If more than 100 records are requested a message will be returned \"The number of records requested exceeds the 100 record limit.\"\t" }, "sorting" : { "type" : "string", "description" : "Sort applies to the selected column (sortingColumnName) and may be specified in Ascending (asc) or Descending (desc) order. The default sort is Descending (desc) - most recent first.", "enum" : [ "asc", "desc" ] }, "sortingColumnName" : { "type" : "string", "description" : "Refers to the column selected to apply the sorting criteria. The default column is dateCreated and will sort by the most recently created quote first with the following in descending order. The default filter retrieves quotes created within the last 30 days. Filtering allows user to select a specific column to sort: quoteNumber, createdDate, lastModifiedDate, expiryDate, and endUserName.", "example" : "toDate", "maxLength" : 100 }, "thirdPartySource" : { "type" : "string", "description" : "Unique identifier used to identify the third party source accessing the services.", "maxLength" : 100 } } } } } } }, "quoteListResponse" : { "title" : "quoteList.Response", "type" : "object", "x-examples" : { "Success" : { "quoteSearchResponse" : { "responsePreamble" : { "responseStatus" : "Passed", "responseStatusCode" : "200", "responseMessage" : "Records Found" }, "quotelist" : [ { "quoteGuid" : "dbabb2a5-02ea-e911-a97b-000d3a30e34c", "quoteName" : "TEST-9771006-1920_CW EndUser11", "quoteNumber" : "QUO-11048-S9P1R3", "revisionNumber" : 0, "endUserName" : "CW EndUser11", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "ec14fd96-02ea-e911-a98d-000d3a30e941", "quoteName" : "TEST-9771006-1920_CW EndUser12", "quoteNumber" : "QUO-11047-M1K1Z6", "revisionNumber" : 0, "endUserName" : "CW EndUser12", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "f3d7d186-02ea-e911-a98d-000d3a30e941", "quoteName" : "TEST-9771006-1920_CW EndUser10", "quoteNumber" : "QUO-11045-G1X9S8", "revisionNumber" : 0, "endUserName" : "CW EndUser10", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "43ae3e7f-02ea-e911-a97a-000d3a30eb04", "quoteName" : "TEST-9771006-1920_CW EndUser9", "quoteNumber" : "QUO-11044-V2F8F9", "revisionNumber" : 0, "endUserName" : "CW EndUser9", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "88062b6f-02ea-e911-a97a-000d3a30eb04", "quoteName" : "TEST-9771006-1920_CW EndUser8", "quoteNumber" : "QUO-11043-W2X1T5", "revisionNumber" : 0, "endUserName" : "CW EndUser8", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" } ], "totalCount" : 5 } }, "Customer Not Found" : { "quoteSearchResponse" : { "responsePreamble" : { "responseStatus" : "Failed", "responseStatusCode" : "400", "responseMessage" : "Customer Not Found" }, "totalCount" : 0 } }, "Wrong sort column" : { "quoteSearchResponse" : { "responsePreamble" : { "responseStatus" : "Failed", "responseStatusCode" : "400", "responseMessage" : "Provide valid sort column name" }, "totalCount" : 0 } } }, "description" : "Response schema for get quote list endpoint", "x-tags" : [ "quotes" ], "properties" : { "quoteSearchResponse" : { "type" : "object", "properties" : { "responsePreamble" : { "type" : "object", "properties" : { "responseStatus" : { "type" : "string", "description" : "Status of the Request - \"Passed\", \"Failed\"" }, "responseStatusCode" : { "type" : "string", "description" : "responseStatusCode is the code returned in response to a request. The following Codes are returned: 200 400 500" }, "responseMessage" : { "type" : "string", "description" : "200 = Action was successfully received, understood and accepted. 400 = The request contains bad syntax or can not be fullfilled. This means there is a problem with the request. 500 = The server failed to fulfill an apparently valid request. This is a temporary problem, the request should be resubmitted." } } }, "quoteList" : { "type" : "array", "items" : { "type" : "object", "properties" : { "quoteName" : { "type" : "string", "description" : "Quote Name given to quote by sales team or system generated. Generally used as a reference to identify the quote." }, "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes." }, "revisionNumber" : { "type" : "integer", "description" : "When a quote has been revised and updated, the quote number remains the same throughout the lifecycle of the quote, however, a Revision number is updated for each revision of the quote. The revision numbers is associated with the Unique Quote Number." }, "endUserName" : { "type" : "string", "description" : "End User Name is the end customer name that is associated with a quote in Ingram Micro's CRM" }, "bidNumber" : { "type" : "string", "description" : "Special Pricing Bid Number, also refers to as Dart Number relates to a unique pricing deal associated with a vendor for the quote." }, "totalAmount" : { "type" : "string", "description" : "Total amount of quoted price for all products in the quote." }, "quoteStatus" : { "type" : "string", "description" : "This refers to the primary status of the quote. API responses will return: Active" }, "createdDate" : { "type" : "string", "description" : "Date the Quote was initially Created", "format" : "date", "example" : "2019-10-08" }, "lastModifiedDate" : { "type" : "string", "description" : "Date the Quote was last updated or modified.", "format" : "date", "example" : "2019-10-08" }, "quoteExpiryDate" : { "type" : "string", "description" : "Date the Quote Expires", "format" : "date", "example" : "2019-10-08" } } } }, "totalCount" : { "type" : "integer", "description" : "Total count of quotes retrieved in the request response." } } } } }, "quoteDetailsRequest" : { "title" : "quoteDetails.Request", "type" : "object", "properties" : { "quoteProductsRequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "properties" : { "customerNumber" : { "type" : "string", "description" : "Reseller Number (referred to as the account BCN) is the unique identifier for an Ingram Micro customer account." }, "isoCountryCode" : { "type" : "string", "description" : "The ISO country codes are internationally recognized codes designated for each country represented by a two-letter combination (alpha-2)." } }, "required" : [ "customerNumber", "isoCountryCode" ] }, "retrieveQuoteProductsRequest" : { "type" : "object", "properties" : { "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes." }, "thirdPartySource" : { "type" : "string", "description" : "Unique identifier used to identify the third party source accessing the services." } } } } } }, "x-examples" : { "Example" : { "quoteProductsRequest" : { "requestPreamble" : { "customerNumber" : "21222222", "isoCountryCode" : "US" }, "retrieveQuoteProductsRequest" : { "quoteNumber" : "QUO-04959-C3V6L4", "thirdPartySource" : "3RDPIDCONWISE" } } } }, "description" : "Request schema for get quote details endpoint", "x-tags" : [ "quotes" ] }, "quoteDetails" : { "title" : "quoteDetails.Response", "type" : "object", "x-tags" : [ "quotes" ], "properties" : { "quoteDetailResponse" : { "type" : "object", "properties" : { "responsePreamble" : { "type" : "object", "properties" : { "responseStatus" : { "type" : "string" }, "statusCode" : { "type" : "string" }, "responseMessage" : { "type" : "string" } } }, "retrieveQuoteResponse" : { "type" : "object", "properties" : { "quoteGuid" : { "type" : "string" }, "quoteName" : { "type" : "string" }, "quoteNumber" : { "type" : "string" }, "quoteExpiryDate" : { "type" : "string", "format" : "date", "example" : "2020-01-01" }, "revisionNumber" : { "type" : "string" }, "introPreamble" : { "type" : "string" }, "purchaseInstructions" : { "type" : "string" }, "legalTerms" : { "type" : "string" }, "currencyCode" : { "type" : "string" }, "priceDeviationId" : { "type" : "string" }, "priceDeviationStartDate" : { "type" : "string", "format" : "date" }, "priceDeviationExpiryDate" : { "type" : "string", "format" : "date" }, "customerNeed" : { "type" : "string" }, "solutionProposed" : { "type" : "string" }, "status" : { "type" : "string" }, "created" : { "type" : "string", "format" : "date", "example" : "2019-10-04" }, "modified" : { "type" : "string", "format" : "date", "example" : "2019-10-04" }, "leasingCalculations" : { "type" : "string" }, "leasingInstructions" : { "type" : "string" }, "accountInfo" : { "type" : "object", "properties" : { "accountName" : { "type" : "string" }, "bcn" : { "type" : "string" }, "phone" : { "type" : "string" } } }, "contactInfo" : { "type" : "object", "properties" : { "contactEmail" : { "type" : "string" }, "contactName" : { "type" : "string" } } }, "vendorAttributes" : { "type" : "object", "properties" : { "estimateId" : { "type" : "string" }, "dealId" : { "type" : "string" }, "vendorName" : { "type" : "string" }, "vendorSettingMessage" : { "type" : "string" } } }, "endUser" : { "type" : "object", "properties" : { "endUserName" : { "type" : "string" }, "endUserAddress" : { "type" : "string" }, "endUserAddress2" : { "type" : "string" }, "endUserAddress3" : { "type" : "string" }, "endUserCity" : { "type" : "string" }, "endUserState" : { "type" : "string" }, "endUserEmail" : { "type" : "string" }, "endUserPhone" : { "type" : "string" }, "endUserZipCode" : { "type" : "string" }, "endUserContactName" : { "type" : "string" }, "endUserMarketSegment" : { "type" : "string" } } } } }, "quoteProductList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/quoteProductList" } }, "totalQuoteProductCount" : { "type" : "string" }, "totalExtendedMsrp" : { "type" : "string" }, "totalQuantity" : { "type" : "integer" }, "totalExtendedQuotePrice" : { "type" : "string" } } } }, "description" : "Response schema for quote details" }, "quoteProductList" : { "title" : "quoteDetails.quoteProductList.Response", "type" : "object", "x-tags" : [ "quotes" ], "properties" : { "quoteProductGuid" : { "type" : "string" }, "quantity" : { "type" : "string" }, "comments" : { "type" : "string" }, "bidStartDate" : { "type" : "string" }, "bidExpiryDate" : { "type" : "string" }, "sku" : { "type" : "string" }, "lineNumber" : { "type" : "string" }, "description" : { "type" : "string" }, "vendorPartNumber" : { "type" : "string" }, "weight" : { "type" : "string" }, "isSuggestionProduct" : { "type" : "string" }, "vpnCategory" : { "type" : "string" }, "quoteProductsSupplierPartAuxiliaryId" : { "type" : "string" }, "quoteProductsVendor" : { "type" : "string" }, "price" : { "type" : "object", "properties" : { "quotePrice" : { "type" : "number" }, "msrp" : { "type" : "number" }, "extendedMsrp" : { "type" : "number" }, "extendedQuotePrice" : { "type" : "number" } } } }, "description" : "" }, "ProductSearchResponse" : { "title" : "productSearchResponse", "type" : "object", "description" : "Response object model for the product search endpoint", "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsePreamble" : { "type" : "object" }, "productsearchresponse" : { "type" : "object", "properties" : { "numberOfResults" : { "type" : "string", "description" : "Number of records in the search result." }, "product" : { "type" : "array", "items" : { "type" : "object", "properties" : { "vendor" : { "type" : "string", "description" : "Name of the vendor, manufacture or brand." }, "vendornumber" : { "type" : "string", "description" : "4 digit unique vendor # creted by Ingram", "example" : "4063" }, "ingrampartnumber" : { "type" : "string", "description" : "Unique Ingram part number" }, "vendorpartnumber" : { "type" : "string", "description" : "Vendor provided number" }, "customerpartnumber" : { "type" : "string", "description" : "Customer’s designated part number." }, "iscustomerauthorized" : { "type" : "string", "description" : "Is customer authorized for purchase of this product?" }, "partdescription" : { "type" : "string", "description" : "Part description" }, "UPC" : { "type" : "string", "description" : "Universal Product Code" } } } } } } } } }, "x-tags" : [ "product catalog" ] }, "productSearchRequest" : { "title" : "productSearchRequest", "type" : "object", "properties" : { "servicerequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "properties" : { "isocountrycode" : { "type" : "string" }, "customernumber" : { "type" : "string" }, "vendornumber" : { "type" : "string" } }, "required" : [ "isocountrycode", "customernumber" ] }, "productsearchrequest" : { "type" : "object", "properties" : { "searchcriteria" : { "type" : "object", "properties" : { "vendor" : { "type" : "string", "description" : "Name of the vendor or manufacturer or brand of the product" }, "vendorpartnumber" : { "type" : "string", "description" : "Vendor provided part number", "example" : "WKB-1500GB" }, "partdescription" : { "type" : "string", "description" : "This field seraches the decriptioon of the product.", "example" : "WRLS ERGO KEYBOARD & MOUSE" }, "UPC" : { "type" : "string", "description" : "Universal Product Code", "example" : "783750005524" }, "customerpartnumber" : { "type" : "string", "description" : "Customer’s designated part number " } } } } } } } }, "x-examples" : { "Using Vendor Part #" : { "servicerequest" : { "requestpreamble" : { "customernumber" : "20-222222", "isocountrycode" : "US" }, "productsearchrequest" : { "searchcriteria" : { "vendorpartnumber" : "TESTE IS" } } } } }, "description" : "Request object model for the product search endpoint", "x-tags" : [ "product catalog" ] }, "multiSKUPriceAndStockResponse" : { "title" : "multiSKUPriceAndStockResponse", "type" : "object", "x-examples" : { "Success" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS", "statuscode" : "200", "responsemessage" : "Data Found" }, "priceandstockresponse" : { "details" : [ { "itemstatus" : "SUCCESS", "statusmessage" : "A-No qty breaks availa", "ingrampartnumber" : "TB6489", "vendorpartnumber" : "H1180HD", "globalskuid" : "A300-TB6489", "customerprice" : 850.54, "currency" : "USD", "partdescription1" : "H1180HD DLP 3D PROJ 2000L 1080PPROJ", "partdescription2" : "10000:1 VGA HDMI RCA", "vendornumber" : "Q680", "vendorname" : "VIVITEK", "cpucode" : "DLP-PR", "class" : "X", "skustatus" : "ACTIVE", "mediacpu" : "PROJ DLP-PR", "categorysubcategory" : "04 25", "retailprice" : 899, "newmedia" : "PROJ", "backorderflag" : "N", "skuauthorized" : "Y", "warehousedetails" : [ { "warehouseid" : "80", "warehousedescription" : "Jonestown, PA", "availablequantity" : 0, "onorderquantity" : 0 }, { "warehouseid" : "10", "warehousedescription" : "Mira Loma, CA", "availablequantity" : 0, "onorderquantity" : 0 } ] } ] } } }, "Invalid Customer" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "FAILED", "statuscode" : "500", "responsemessage" : "Data Not Found" }, "priceandstockresponse" : { "details" : [ { "itemstatus" : "FAILED", "statusmessage" : "E-INVALID CUSTOMER NUMBER" }, { "itemstatus" : "FAILED", "statusmessage" : "E-INVALID CUSTOMER NUMBER" }, { "itemstatus" : "FAILED", "statusmessage" : "E-INVALID CUSTOMER NUMBER" } ] } } }, "Invalid Country " : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESSWITHERROR", "statuscode" : "046", "responsemessage" : "Partial Data Found" }, "priceandstockresponse" : { "details" : [ { "itemstatus" : "SUCCESS", "statusmessage" : "edv 2", "ingrampartnumber" : "NaN", "vendorpartnumber" : null, "globalskuid" : "A001-NaN", "customernumber" : "20-222222", "quantity" : 0, "customerprice" : 0, "vendornumber" : "NaN", "retailprice" : 0, "enduserrequired" : "false", "specialpromoflag" : "false", "isavailable" : false, "isstocakable" : false, "isbom" : false, "hasquantitybreaks" : false, "haswebdiscounts" : false, "issboprice" : false, "extendednetamount" : 0, "taxamount" : 0, "totalfeeamount" : 0, "totalpromotionamount" : 0, "totalenvironmentalfees" : 0 } ] } } } }, "x-tags" : [ "product catalog" ], "description" : "Response object model for the multi sku price and stock API endpoint", "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string", "description" : "SUCCESS or FAILED, sometimes PARTIAL SUCCESS if connection to 1 of the systems fails" }, "responsemessage" : { "type" : "string", "description" : "Overall status message including error message" }, "statuscode" : { "type" : "string", "description" : "Statuscode Message" } } }, "priceandstockresponse" : { "type" : "object", "properties" : { "details" : { "type" : "array", "items" : { "type" : "object", "properties" : { "itemstatus" : { "type" : "string" }, "statusmessage" : { "type" : "string" }, "ingrampartnumber" : { "type" : "string", "description" : "SKU number for the product for which order needs to be created with Ingram Micro", "maxLength" : 6 }, "vendorpartnumber" : { "type" : "string", "description" : "Vendor Part number for the product", "maxLength" : 21 }, "globalskuid" : { "type" : "string" }, "customerprice" : { "type" : "string", "description" : "Customer specific price for the product, excluding taxes" }, "partdescription1" : { "type" : "string", "description" : "Description on the part number that is being requested" }, "partdescription2" : { "type" : "string", "description" : "Contuiation of description on the part number that is being requested" }, "vendornumber" : { "type" : "string", "description" : "Internal four digit code assigned by Ingram", "maxLength" : 4 }, "vendorname" : { "type" : "string", "description" : "Name of the vendor" }, "cpucode" : { "type" : "string", "description" : "Ingram internal code for a product", "maxLength" : 6 }, "class" : { "type" : "string", "description" : "Ingram Micro assigned product classification.", "enum" : [ "A-Stocked product in all IM warehouses", "B-Limited stock in IM warehouses", "C-Stocked in fewer wareshouses", "D-Ingram discontinued", "E-Planned to be phased out as per the vendor", "F-Carried for specific customer as per the contract", "N-New SKU", "O-Discontinued to be liquidated", "S-Order for specialized demand", "V-Discontinued by vendor", "X-Direct Ship products from vendor" ], "maxLength" : 1 }, "skustatus" : { "type" : "string", "description" : "Identifies if the SKU has been discontinued. Rules must be defined on the values to be sent out to partner.", "maxLength" : 1 }, "mediacpu" : { "type" : "string" }, "categorysubcategory" : { "type" : "string", "description" : "Ingram's internal categorization of the product" }, "retailprice" : { "type" : "number", "description" : "MSRP Price 0.00" }, "newmedia" : { "type" : "string", "description" : "Internal four-digit code assigned by Ingram to represent the item group" }, "enduserrequired" : { "type" : "string", "description" : "Y - End user required N - Not required End user", "enum" : [ "Y-End user data required", "N-End user data not required" ], "maxLength" : 1 }, "backorderflag" : { "type" : "string", "description" : "Y- Allow Backorder Flag N- Not allowed", "enum" : [ "Y- Can be backordered", "N-Cannot be backordered" ], "maxLength" : 1 }, "skuauthorized" : { "type" : "string" }, "extendedvendorpartnumber" : { "type" : "string" }, "warehousedetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "warehouseid" : { "type" : "string", "description" : "Unique 2-digit code of the Ingram Micro warehouse", "enum" : [ "10-Mira Loma CA", "20-Carrollton TX", "30-Millington TN", "40-Carol Stream IL", "80-Jonestown PA" ] }, "warehousedescription" : { "type" : "string", "description" : "City of the Ingram Micro warehouse location" }, "availablequantity" : { "type" : "integer", "description" : "On hand available quantity" }, "onorderquantity" : { "type" : "integer", "description" : "On Order quantity" }, "onholdquantity" : { "type" : "string" }, "etadate" : { "type" : "string" } } } } }, "required" : [ "retailprice" ] } } } } } } } }, "multiSKUPriceAndStockRequest" : { "title" : "multiSKUPriceAndStockRequest", "type" : "object", "description" : "Request object model for the multi sku price and stock API endpoint", "x-examples" : { "Example" : { "servicerequest" : { "requestpreamble" : { "customernumber" : "20-222222", "isocountrycode" : "US" }, "priceandstockrequest" : { "showwarehouseavailability" : "True", "extravailabilityflag" : "Y", "item" : [ { "ingrampartnumber" : "M93592", "quantity" : 1 } ], "includeallsystems" : false } } } }, "x-tags" : [ "product catalog" ], "properties" : { "servicerequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "properties" : { "isocountrycode" : { "type" : "string", "description" : "2 Digit code\n“US”-United States\n“CA”-Canada", "example" : "US", "minLength" : 2, "maxLength" : 2 }, "customernumber" : { "type" : "string", "description" : "Ingram Micro customer number\n10-12389", "example" : "20-222222" } }, "required" : [ "isocountrycode", "customernumber" ] }, "priceandstockrequest" : { "type" : "object", "properties" : { "showwarehouseavailability" : { "type" : "string", "description" : "True/false to show the availability of individual warehouses" }, "extravailabilityflag" : { "type" : "string", "description" : "Y/N to show extra availability flag" }, "includeallsystems" : { "type" : "boolean", "description" : "Flag to indicate if the price and stock information is required for all Ingram Micro systems. If it is set to true, the price and stock details will be returned from all Ingram Micro systems and if false, the price and stock will have returned from the system where the reseller number is set up in." }, "item" : { "type" : "object", "properties" : { "index" : { "type" : "integer" }, "ingrampartnumber" : { "type" : "string", "description" : "Ingram Micro system specific SKU number for the product for which the price is requested at Ingram Micro" }, "vendorpartnumber" : { "type" : "string", "description" : "Vendor Part Number for the product for which the price is requested at Ingram Micro" }, "UPC" : { "type" : "string", "description" : "Universal Product code for the product for which the price is requested at Ingram Micro" }, "customerpartnumber" : { "type" : "string", "description" : "Unique identification number of customer. For this option the Ingram Micro Sales rep must set up a cross reference table. " }, "warehouseidlist" : { "type" : "string", "description" : "Unique identity for Ingram Micro warehouses against which stock details are returned." } } } } } } } } }, "invoiceDetailRequest" : { "title" : "invoiceDetailRequest", "type" : "object", "x-tags" : [ "invoices" ], "properties" : { "servicerequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "properties" : { "isocountrycode" : { "type" : "string" }, "customernumber" : { "type" : "string" } }, "required" : [ "isocountrycode", "customernumber" ] }, "invoicedetailrequest" : { "type" : "object", "properties" : { "invoicenumber" : { "type" : "string" } }, "required" : [ "invoicenumber" ] } } } }, "x-examples" : { "Example" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "invoicedetailrequest" : { "invoicenumber" : "60ABCDE11" } } } } }, "invoiceDetailResponse" : { "title" : "invoiceDetailResponse", "type" : "object", "x-tags" : [ "invoices" ], "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string" }, "statuscode" : { "type" : "string" }, "responsemessage" : { "type" : "string" } } }, "invoicedetailresponse" : { "type" : "object", "properties" : { "customernumber" : { "type" : "string" }, "invoicenumber" : { "type" : "string" }, "invoicedate" : { "type" : "string", "format" : "date" }, "invoicetype" : { "type" : "string" }, "customerordernumber" : { "type" : "string" }, "customerfreightamount" : { "type" : "number", "format" : "double" }, "customerforeignfrightamt" : { "type" : "number", "format" : "float" }, "totaltaxamount" : { "type" : "number", "format" : "double" }, "totalamount" : { "type" : "number", "format" : "double" }, "shiptosuffix" : { "type" : "string" }, "billtosuffix" : { "type" : "string" }, "freightamount" : { "type" : "number", "format" : "double" }, "paymentterms" : { "type" : "string" }, "orderdate" : { "type" : "string" }, "carrier" : { "type" : "string" }, "carrierdescription" : { "type" : "string" }, "discountamount" : { "type" : "number", "format" : "double" }, "taxtype" : { "type" : "string" }, "enduserponumber" : { "type" : "string" }, "freightforwardercode" : { "type" : "string" }, "creditmemoreasoncode" : { "type" : "string" } } } } } } }, "orderModifyResponse" : { "title" : "orderModifyResponse", "type" : "object", "description" : "Response schema for order modify endpoint", "x-tags" : [ "orders" ], "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string" }, "responsemessage" : { "type" : "string" } } }, "ordermodifyresponse" : { "type" : "object", "properties" : { "responseflag" : { "type" : "string" }, "errortype" : { "type" : "string" }, "acktriggered" : { "type" : "string" }, "warncode" : { "type" : "string" }, "headerresponse" : { "type" : "string" }, "" : { "type" : "string" } } } } } } }, "orderModifyRequest" : { "title" : "orderModifyRequest", "type" : "object", "description" : "Request schema for order modify endpoint", "x-tags" : [ "orders" ], "properties" : { "servicerequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "properties" : { "isocountrycode" : { "type" : "string" }, "customernumber" : { "type" : "string" } } }, "ordermodifyrequest" : { "type" : "object", "properties" : { "ingramorderbranch" : { "type" : "string" }, "ingramordernumber" : { "type" : "string" }, "ingramorderdist" : { "type" : "string" }, "ingramordership" : { "type" : "string" }, "customerponumber" : { "type" : "string" }, "shipto" : { "type" : "object", "properties" : { "Id" : { "type" : "string" }, "name" : { "type" : "string" }, "addressline" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" } } }, "headerdata" : { "type" : "object", "properties" : { "actioncode" : { "type" : "string" }, "shipviacode" : { "type" : "string" } } }, "linedata" : { "type" : "array", "items" : { "type" : "object", "properties" : { "addlineorupdateline" : { "type" : "string" }, "linenumber" : { "type" : "string" }, "customerlinenumber" : { "type" : "string" }, "ingrampartnumber" : { "type" : "string" }, "quantityordered" : { "type" : "integer" }, "customerpartnumber" : { "type" : "string" }, "linetype" : { "type" : "string" } } } } } } } } } }, "OrderSearchResponse" : { "title" : "orderSearchResponse", "type" : "object", "properties" : { "serviceResponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "requeststatus" : { "type" : "string" }, "returnmessage" : { "type" : "string" }, "returncode" : { "type" : "string" } } }, "orderlookupresponse" : { "type" : "object", "properties" : { "numberrfresults" : { "type" : "string" }, "responsedata" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ordernumber" : { "type" : "string" }, "entrytimestamp" : { "type" : "string" }, "customerordernumber" : { "type" : "string" }, "endUserordernumber" : { "type" : "string" }, "shipment" : { "type" : "array", "items" : { "type" : "object", "properties" : { "distributionnumber" : { "type" : "string" }, "shipmentnumber" : { "type" : "string" }, "branchnumber" : { "type" : "string" }, "statuscode" : { "type" : "string" }, "status" : { "type" : "string" } } } } } } } } } } } }, "description" : "Response schema for order search endpoint" }, "orderSearchRequest" : { "title" : "orderSearchRequest", "type" : "object", "description" : "Request schema for order search endpoint", "properties" : { "servicerequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "required" : [ "isoCountryCode", "customerNumber" ], "properties" : { "isoCountryCode" : { "type" : "string" }, "customerNumber" : { "type" : "string" } } }, "orderLookupRequest" : { "type" : "object", "properties" : { "orderNumber" : { "type" : "object", "properties" : { "entryDate" : { "type" : "string" }, "orderBranch" : { "type" : "string" }, "orderNumber" : { "type" : "string" }, "distributionNumber" : { "type" : "string" }, "shipmentNumber" : { "type" : "string" } }, "required" : [ "entryDate", "orderBranch" ] }, "customerOrderNumber" : { "type" : "object", "properties" : { "customerOrderNumber" : { "type" : "string" } } } } } }, "required" : [ "requestpreamble" ] } }, "x-examples" : { "Example" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "orderlookuprequest" : { "status" : { "fromdate" : "2020-01-07", "todate" : "2020-01-14" } } } } }, "x-tags" : [ "orders" ] }, "orderDeleteResponse" : { "title" : "orderDeleteResponse", "type" : "object", "x-tags" : [ "orders" ], "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "requestStatus" : { "type" : "string" }, "returnCode" : { "type" : "string" }, "returnMessage" : { "type" : "string" } } } } } }, "description" : "Response schema for order delete endpoint", "x-examples" : { "Example" : { "serviceresponse" : { "responsepreamble" : { "requestStatus" : "SUCCESS", "returnCode" : "00", "returnMessage" : "Order Deleted Successfully" } } } } }, "orderDeleteRequest" : { "title" : "orderDeleteRequest", "type" : "object", "x-tags" : [ "orders" ], "description" : "Request schema for order delete endpoint", "x-examples" : { "Example" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customerumber" : "20-222222" }, "OrderDeleteRequestDetails" : { "entryDate" : "2019-01-22", "orderBranch" : "20", "orderNumber" : "RC62Z" } } } }, "properties" : { "servicerequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "required" : [ "isocountrycode", "customerNumber" ], "properties" : { "isocountrycode" : { "type" : "string", "description" : "Country that Order is being place in." }, "customerNumber" : { "type" : "string", "description" : "Account number order will be billed to.\nINGRAM MICRO ACCOUNT NUMBER REQUIRED" } } }, "OrderDeleteRequestDetails" : { "type" : "object", "properties" : { "entryDate" : { "type" : "string", "description" : "Date order entered", "example" : "8/25/2018" }, "orderBranch" : { "type" : "string", "description" : "Ingram Micro's first 2 numbers of the order number" }, "orderNumber" : { "type" : "string", "description" : "Ingram Micro's middle 6 numbers of the order#" }, "rejectionCode" : { "type" : "string" }, "distributionNumber" : { "type" : "string", "description" : "Ingram Micro's suffix number of the order#" }, "shipmentNumber" : { "type" : "string", "description" : "Ingram Micro's last number of the order#" }, "operatorID" : { "type" : "string", "description" : "Ingram ID(not required)" } }, "required" : [ "entryDate", "orderBranch", "orderNumber" ] } }, "required" : [ "requestpreamble" ] } } }, "orderDetailsResponse" : { "title" : "orderDetailResponse", "type" : "object", "x-tags" : [ "orders" ], "description" : "Response schema for order details endpoint", "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "responsestatus" : { "type" : "string" }, "statuscode" : { "type" : "string" }, "responsemessage" : { "type" : "string" } } }, "orderdetailresponse" : { "type" : "object", "properties" : { "ordernumber" : { "type" : "string" }, "ordertype" : { "type" : "string", "description" : "Order Type\t\t\nB - BRANCH TRANSFER\nC - CASH ORDER\nD - DIRECT ORDER\nF - FUTURE ORDER\nP - SPECIAL ORDER\nQ - QUOTE ORDER\nS - STOCK ORDER\nM - MEMO ORDER" }, "customerordernumber" : { "type" : "string", "description" : "Customer PO number" }, "enduserponumber" : { "type" : "string", "description" : "End User PO number" }, "orderstatus" : { "type" : "string", "description" : "Status of order within Ingram system\nS - SALES HOLD\nH - TAG HOLD\nI - INVOICED\nP - PENDING\nE - BILLING ERROR\nF - FORCE BILLING\nV - VOIDED\nT - TRANSFERRED\nD - HOLD SHIPMENT\nR - RELEASED\nO - IM ONLINE HOLD\nU - BILL FOR HISTORY ONLY\nW - ORDER NOT PRINTED\nA - DROP SHIP HOLD\nB - INTERNET CUST ORIG HOLD\n1 - PICKED\n2 - INSPECTED\n3 - PACKED\n4 - SHIPPED\nC - CREDIT HOLD\n9 - CISCO 3A6\nQ - RMA HOLD\nG - CREDIT HOLD\nN - CREDIT HOLD" }, "entrytimestamp" : { "type" : "string", "description" : "Time stamp of the order placed" }, "entrymethoddescription" : { "type" : "string", "description" : "Description of the entry method\t" }, "ordertotalvalue" : { "type" : "number", "description" : "Total order value" }, "ordersubtotal" : { "type" : "number", "description" : "Subtotal order value" }, "freightamount" : { "type" : "string", "description" : "Freight charges" }, "currencycode" : { "type" : "string", "description" : "Country specific currency code" }, "totalweight" : { "type" : "string", "description" : "Total order weight. unit -- North america - Pounds , other countries will be KG" }, "totaltax" : { "type" : "string", "description" : "total tax on the orders placed" }, "billtoaddress" : { "type" : "object", "properties" : { "suffix" : { "type" : "string" }, "name" : { "type" : "string" }, "attention" : { "type" : "string" }, "addressline1" : { "type" : "string" }, "addressline2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" } } }, "shiptoaddress" : { "type" : "object", "properties" : { "suffix" : { "type" : "string" }, "attention" : { "type" : "string" }, "name" : { "type" : "string" }, "addressline1" : { "type" : "string" }, "addressline2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" } } }, "enduserinfo" : { "type" : "object", "properties" : { "enduserid" : { "type" : "string" } } }, "lines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "linenumber" : { "type" : "string", "description" : "Impulse line number" }, "globallinenumber" : { "type" : "string", "description" : "Line of the Globel Sku / Customer Line Number" }, "ordersuffix" : { "type" : "string", "description" : "Order Suffix" }, "erpordernumber" : { "type" : "string", "description" : "Sales order number" }, "linestatus" : { "type" : "string", "description" : "Status of the line" }, "partnumber" : { "type" : "string", "description" : "Ingram part number" }, "manufacturerpartnumber" : { "type" : "string", "description" : "manufacture number of the product" }, "vendorname" : { "type" : "string", "description" : "name of the vendor" }, "vendorcode" : { "type" : "string", "description" : "Ingram Micro assigned code for the vendor" }, "partdescription1" : { "type" : "string" }, "partdescription2" : { "type" : "string" }, "unitweight" : { "type" : "string", "description" : "weight of the product unit" }, "unitprice" : { "type" : "number", "description" : "Customer price of the unit" }, "extendedprice" : { "type" : "number", "description" : "extended price of the order" }, "taxamount" : { "type" : "number", "description" : "tax amount for the order" }, "requestedquantity" : { "type" : "string", "description" : "no. of units requested" }, "confirmedquantity" : { "type" : "string", "description" : "no. of units confirmed available" }, "backorderquantity" : { "type" : "string", "description" : "quantity of back order" }, "serialnumberdetails" : { "type" : "object", "properties" : { "serialnumber" : { "type" : "string", "description" : "serial number of the ordered SKU" } } }, "trackingnumber" : { "type" : "string", "description" : "tracking number of the order" }, "shipmentdetails" : { "type" : "array", "items" : { "type" : "object", "properties" : { "quantity" : { "type" : "number", "description" : "quantity shipped" }, "shipmentdate" : { "type" : "string", "description" : "date of shipment" }, "shipfromwarehouseid" : { "type" : "string", "description" : "Warehouse product was shipped from" }, "warehousename" : { "type" : "string", "description" : "name of the warehouse" }, "invoicenumber" : { "type" : "string", "description" : "Invoice Number" }, "invoicedate" : { "type" : "string", "description" : "date on the invoice generated" }, "status" : { "type" : "string", "description" : "code for current Status of the order" }, "statusdescription" : { "type" : "string", "description" : "Description of status" }, "shippeddate" : { "type" : "string", "description" : "date of shipment" }, "holdreasoncodedescription" : { "type" : "string", "description" : "Description of the code if the order is on hold" }, "ponumber" : { "type" : "string", "description" : "Ingram PO Number to vendors for direct ship orders" }, "carriercode" : { "type" : "string", "description" : "" }, "carriername" : { "type" : "string", "description" : "name of the carrier" }, "pronumber" : { "type" : "string", "description" : "the condition is being handled in Insideline / Impulse. And data gets populated based upon the rules in backend systems" }, "packagedetails" : { "type" : "object", "properties" : { "trackingnumber" : { "type" : "string" }, "packageweight" : { "type" : "string" }, "cartonnumber" : { "type" : "string" }, "quantityinbox" : { "type" : "string" } } } } } }, "productextendedspecs" : { "type" : "object", "properties" : { "attributename" : { "type" : "string" }, "attributevalue" : { "type" : "string" } } }, "backorderetadate" : { "type" : "string", "description" : "estimated date of back order" } } } }, "commentlines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "commenttext1" : { "type" : "string" }, "commenttext2" : { "type" : "string" } } } }, "miscfeeline" : { "type" : "array", "items" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Handling charges/Miscellaneous Fee description" }, "chargeamount" : { "type" : "string", "description" : "Handling charges/ Miscelaneous fee amount" } } } }, "extendedspecs" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributename" : { "type" : "string", "description" : "termscode' | 'termsdescription' | 'commenttext' are the atrribute name" }, "attributevalue" : { "type" : "string", "description" : "values of these fields are send . termscode' | 'termsdescription' | 'commenttext' are the atrribute name" } } } } } } } } }, "x-examples" : { "Example" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "orderdetailresponse" : { "ordernumber" : "10-12345", "customerordernumber" : "test order", "enduserponumber" : "ABC", "orderstatus" : "INVOICED", "entrytimestamp" : "2018-07-15T04:31:42-07:00", "entrymethoddescription" : "XML/PCG", "fulfilmentordercode" : "Y", "ordertotalvalue" : 3907.38, "ordersubtotal" : 3907.38, "freightamount" : 141.34, "currencycode" : "USD", "totalweight" : "86", "totaltax" : "0", "billtoaddress" : { "suffix" : "000", "name" : "Ingram Micro", "addressline1" : "123 Ingram Way", "addressline2" : null, "city" : "Irvine", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "shiptoaddress" : { "name" : "Mr Customer", "addressline1" : "123 Main St", "city" : "Anywhere", "state" : "CA", "postalcode" : "12345000", "countrycode" : "US" }, "lines" : [ { "globallinenumber" : "001", "ordersuffix" : "11", "linestatus" : "INVOICED", "partnumber" : "3AM612", "manufacturerpartnumber" : "QN75Q8FNBFXZA", "vendorname" : "SAMSUNG - CONSUMER TV", "partdescription1" : "75IN Q8 FLAT 4K UHD HDR SMARTTV", "partdescription2" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE", "freeitempromoflag" : "false", "unitweight" : "75", "unitprice" : 50000.48, "foreignunitprice" : 0, "extendedprice" : 5000.48, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-16", "shipfromwarehouseid" : "40", "warehousename" : "Carol Stream, IL", "invoicenumber" : "1234511", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-16", "carriercode" : "AY", "carriername" : "ORD4708752", "packagedetails" : { "trackingnumber" : 6838019, "packageweight" : 80, "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-11", "vendorcode" : "Q012", "isacopapplied" : "N", "adjustedcost" : "5000.09", "serialnumberdetails" : { "serialnumber" : "07AS3CAK500682" }, "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "FULL ARRAY BACKLIGHTIN CLEAN CABLE" } }, { "globallinenumber" : "002", "ordersuffix" : "21", "linestatus" : "INVOICED", "partnumber" : "2GH590", "manufacturerpartnumber" : "F-ADT-STR-KT-1", "vendorname" : "SAMSUNG - SMART THINGS", "partdescription1" : "ADT HOME SECURITY STARTER KIT", "partdescription2" : "SECURITY STARTER KIT", "freeitempromoflag" : "false", "unitweight" : "5.15", "unitprice" : 500.9, "foreignunitprice" : 0, "extendedprice" : 500.9, "foreignextendedprice" : 0, "taxamount" : 0, "requestedquantity" : "1", "confirmedquantity" : "1", "backorderquantity" : "0", "promisedate" : "2018-07-15", "shipmentdetails" : [ { "quantity" : 1, "shipmentdate" : "2018-07-17", "shipfromwarehouseid" : "80", "warehousename" : "Jonestown, PA", "invoicenumber" : "1234521", "invoicedate" : "2018-07-16", "status" : "I", "statusdescription" : "INVOICED", "shippeddate" : "2018-07-17", "carriercode" : "RG", "carriername" : "FEDEX GROUND", "packagedetails" : { "trackingnumber" : "017136225260674", "packageweight" : "000000006", "cartonnumber" : "001", "quantityinbox" : "0000001" } } ], "erpordernumber" : "10-12345-21", "vendorcode" : "QG64", "isacopapplied" : "N", "adjustedcost" : "400.99", "productextendedspecs" : { "attributename" : "commenttext", "attributevalue" : "SECURITY STARTER KIT" } } ], "extendedspecs" : [ { "attributename" : "termscode", "attributevalue" : "300" }, { "attributename" : "termsdescription", "attributevalue" : "NET 30 DAYS" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" }, { "attributename" : "commenttext", "attributevalue" : "PHONE:7148675309" } ], "ordertype" : "S", "erpid" : null } } } } }, "orderDetailRequest" : { "title" : "orderDetailRequest", "type" : "object", "x-tags" : [ "orders" ], "description" : "Request schema for order details endpoint", "properties" : { "servicerequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "required" : [ "isocountrycode", "customernumber" ], "properties" : { "isocountrycode" : { "type" : "string" }, "customernumber" : { "type" : "string" } } }, "orderdetailrequest" : { "type" : "object", "properties" : { "ordernumber" : { "type" : "string", "description" : "Ingram Micro Order Number" }, "customerponumber" : { "type" : "string" }, "orderdate" : { "type" : "string" }, "systemid" : { "type" : "string" } }, "required" : [ "ordernumber" ] } }, "required" : [ "requestpreamble" ] } }, "x-examples" : { "Example" : { "servicerequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "orderdetailrequest" : { "ordernumber" : "10-H07XB", "orderdate" : "2018-07-15", "systemid" : "A300" } } } } }, "OrderCreateresponse" : { "title" : "orderCreateResponse", "type" : "object", "x-tags" : [ "Orders" ], "description" : "Response schema for order create endpoint", "x-examples" : { "Example" : { "serviceresponse" : { "responsepreamble" : { "responsestatus" : "SUCCESS" }, "ordercreateresponse" : { "numberoflineswithsuccess" : "1", "numberoflineswitherror" : "0", "numberoflineswithwarning" : "0", "globalorderid" : "20-RBRN9", "customerponumber" : "H3E", "ordertype" : "S", "ordertimestamp" : "2018-07-18", "invoicingsystemorderid" : "20-RBRN9", "taxamount" : 0, "freightamount" : 0, "totalorderamount" : 0, "shiptoaddress" : { "attention" : null, "name" : null, "addressline1" : null, "addressline2" : null, "city" : null, "state" : null, "postalcode" : null, "countrycode" : null }, "lines" : [ { "linetype" : "P", "globallinenumber" : "002", "partnumber" : "4K9938", "globalskuid" : "A300-4K9938", "freeitempromoflag" : "false", "linenumber" : "4", "carriercode" : "WC", "carrierdescription" : "WILL CALL", "requestedunitprice" : 647.6, "requestedquantity" : 1, "confirmedquantity" : 0, "backorderedquantity" : 1, "backorderetadate" : "2018-05-15", "unitproductprice" : 647.6, "netamount" : 0, "warehouseid" : "40", "ordersuffix" : "11", "isacopapplied" : "Y" } ] } } } }, "properties" : { "serviceresponse" : { "type" : "object", "properties" : { "responsepreamble" : { "type" : "object", "properties" : { "Responsepreamble" : { "type" : "string" }, "Responsestatus" : { "type" : "string" } } }, "Ordercreateresponse" : { "type" : "object", "properties" : { "Numberoflineswithsuccess" : { "type" : "string", "description" : "Number of line items that were successful" }, "Numberoflineswitherror" : { "type" : "string", "description" : "Number of line items with error" }, "Numberoflineswithwarning" : { "type" : "string", "description" : "Number of line items with warnings" }, "Globalorderid" : { "type" : "string", "description" : "Ingram sales order number" }, "Customerponumber" : { "type" : "string", "description" : "Customer assigned purchase order number" }, "Ordertype" : { "type" : "string", "description" : "S=Stocked PO D=Direct Ship PO", "enum" : [ "S", "D" ] }, "Ordertimestamp" : { "type" : "string", "description" : "Time order received" }, "Invoicingsystemorderid" : { "type" : "string", "description" : "Ingram Micro generated order number" }, "Taxamount" : { "type" : "number" }, "Freightamount" : { "type" : "number", "description" : "Freight amount customer pays for freight" }, "Totalorderamount" : { "type" : "number", "description" : "Total amount of order with freight and taxes" }, "Shiptoaddress" : { "type" : "object", "properties" : { "Attention" : { "type" : "string", "description" : "Contact person at delivery site" }, "Name" : { "type" : "string", "description" : "Company Name or name of person item being delivered to" }, "addressline1" : { "type" : "string", "description" : "Physical address of delivery" }, "addressline2" : { "type" : "string", "description" : "Continuation of address line 1,\t" }, "City" : { "type" : "string" }, "State" : { "type" : "string" }, "Postalcode" : { "type" : "string" }, "Countrycode" : { "type" : "string" } } }, "Lines" : { "type" : "object", "properties" : { "Linetype" : { "type" : "string", "description" : "“P”-Line or SKU Number “C”-Comment Line" }, "globallinenumber" : { "type" : "string", "description" : "Ingram generated line number" }, "Partnumber" : { "type" : "string", "description" : "Ingram Micro Sku Number" }, "globalskuid" : { "type" : "string" }, "linenumber" : { "type" : "string" }, "carriercode" : { "type" : "string", "description" : "Transportation 2 digit codes" }, "carrierdescription" : { "type" : "string", "description" : "Transportation Carrier Name" }, "requestedunitprice" : { "type" : "number", "description" : "Price requested by reseller. Price Variance can be set up by Ingram Micro Sales Rep" }, "requestedquantity" : { "type" : "integer", "description" : "Quanity Requested" }, "confirmedquantity" : { "type" : "integer", "description" : "Quanity Shipped" }, "backorderedquantity" : { "type" : "integer", "description" : "Quanity of units that didn’t ship" }, "unitproductprice" : { "type" : "number", "description" : "Price Per Unit" }, "netamount" : { "type" : "number", "description" : "Total amount. Quantity X Unit Price" }, "warehouseid" : { "type" : "string" } } } } } } } } }, "OrderCreaterequest" : { "title" : "orderCreateRequest", "type" : "object", "x-examples" : { "Example" : { "ordercreaterequest" : { "requestpreamble" : { "isocountrycode" : "US", "customernumber" : "20-222222" }, "ordercreatedetails" : { "systemid" : "", "customerponumber" : "TESTAPIORBT1", "billtosuffix" : "000", "shiptoaddress" : { "attention" : "HARRY WELLS", "addressline1" : "THE COMPUTER STORE", "addressline2" : "754 LAS PALMAS DR", "city" : "IRVINE", "state" : "CA", "postalcode" : "926022004", "countrycode" : "US" }, "lines" : [ { "linetype" : "P", "linenumber" : "001", "globalskuid" : "", "quantity" : "1", "ingrampartnumber" : "3N7314" } ], "extendedspecs" : [ { "attributename" : "isbackorderflagallowed", "attributevalue" : "Y" } ] } } } }, "x-tags" : [ "orders" ], "description" : "Request schema for order create endpoint", "properties" : { "ordercreaterequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "required" : [ "isocountrycode", "customernumber" ], "properties" : { "isocountrycode" : { "type" : "string", "description" : "This ISO country codes are internationally recognized codes that designates the country that the order is meant to post to. United States= US, Canada = CA" }, "customernumber" : { "type" : "string", "description" : "This is the Ingram Micro account number that is assigned to you. This is the account number that the pricing is based on and where the orders will be billed to. (sample: 20-222222)", "example" : "20-222222" } } }, "ordercreatedetails" : { "type" : "object", "properties" : { "customerponumber" : { "type" : "string", "minLength" : 1, "maxLength" : 18, "description" : "The customers unique Purchase Order number " }, "ordertype" : { "type" : "string", "enum" : [ "Standard", "Direct Ship" ], "description" : "Order Type tells our system if this is standard order or a direct ship order\n•\tCurrently Ingram Micro’s system has 2 types of sales orders. \no\tStandard orders: Orders that contain skus that ship from Ingram Micro’s warehouse locations.\no\tDirect ship orders: Orders for skus, such as licenses, warranties and custom-built hardware skus that ship directly from our vendors.\n\tWe identify SKUs that must be processed separately with a class code of “X”. The class code is found in the daily FTP price file, If Class Code is not included in your FTP Price file, you can request that it be added by contacting 1-800-616-4665. \n" }, "enduserordernumber" : { "type" : "string", "description" : "Customers End-user PO number", "minLength" : 0, "maxLength" : 18 }, "billtosuffix" : { "type" : "string", "description" : "Designates flooring acct to be used", "maxLength" : 3 }, "shiptosuffix" : { "type" : "string", "description" : "Applies to customers with multiple ship to locations (store locations)", "maxLength" : 3 }, "shiptoaddress" : { "type" : "object", "required" : [ "addressline1", "addressline2", "city", "state", "postalcode" ], "properties" : { "attention" : { "type" : "string", "description" : "Customer contact name", "example" : "“Mr. Customer”", "maxLength" : 35 }, "addressline1" : { "type" : "string", "description" : "Company Name or person to deliver.\n\n*If there isn’t an attention line please add the company name on address line 1. UPS and FedEx will create surcharges if address line 1 contains a physical address.", "example" : "“Ingram Micro”", "maxLength" : 35 }, "addressline2" : { "type" : "string", "description" : "Street address for delivery", "example" : "3351 Michelson Dr", "maxLength" : 35 }, "city" : { "type" : "string", "example" : "Irvine", "maxLength" : 21, "description" : "Ship to city" }, "state" : { "type" : "string", "example" : "CA", "maxLength" : 2, "description" : "Ship to State or Region" }, "postalcode" : { "type" : "string", "description" : "Ship to Zip code or Postal code", "example" : "92712", "maxLength" : 9 }, "countrycode" : { "type" : "string", "description" : "Ship to country", "example" : "US", "maxLength" : 2 } } }, "carriercode" : { "type" : "string", "description" : "A customer can dictate what carrier to use for their shipment (Ingram 2-digit carrier code is required). Our recommendation is leave this field blank which will allow Ingram Micro to choose the best carrier to gain the best freight rates.", "maxLength" : 2 }, "thirdpartyfrieghtaccountnumber" : { "type" : "string", "description" : "Refers to a third-party freight account number for charging freight against. The account number should be passed within this field and the appropriate carrier code should be supplied within the carrier code tags. Prior to sending your request containing the third-party account number, it must be first entered into our system. Your Ingram Micro Sales Representative can action this for you. If submitted within an order without this preapproval the third-party account number will be ignored.\n\nNote: USA partners- For FedEx Air only (carrier codes F1, FO, F2, FG.), please send three leading zeros before your third-party freight account number (i.e.: 000999999999.) " }, "specialbidnumber" : { "type" : "string", "description" : "This is the special quote number given to a customer either by a vendor for special pricing or by Ingram Micro. To receive the special pricing assigned to this number it must be included on the order." }, "lines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "linetype" : { "type" : "string", "description" : "Values are “P” for product or “C” for comments. This can be left blank when ordering product and a “P” will be assumed. If you are adding a COMMENT, then this value must be “C”.\n\nExtended spec for comments: \nAttribute Name: “commenttext”\nAttribute Value: “thank you for the order” \nTo make the comment invisible to the packing slip place “///” in front of the comment in the Attribute Value field. This will allow the Ingram sales rep to see the comment on the order but will not forward on to shipping documents.", "enum" : [ "P", "C" ] }, "linenumber" : { "type" : "string", "description" : "This is used when a partner wants to use their own line number. Can be left blank." }, "ingrampartnumber" : { "type" : "string", "description" : "This is the Ingram sku number to be used for placing an order." }, "quantity" : { "type" : "string", "description" : "The quantity that is to be ordered." }, "vendorpartnumber" : { "type" : "string", "description" : "The Manufacturer part number. Can be used to place an order instead of the Ingram sku. If there are multiple Ingram part numbers to one vendor part number. The order will be rejected." }, "customerpartnumber" : { "type" : "string", "description" : "This is the Customers unique part numbers that must be crossed referenced to the Ingram Micro Sku before it can be used. Please contact your sales rep for additional information on how to set this up." }, "UPCCode" : { "type" : "string" }, "warehouseid" : { "type" : "string" }, "unitprice" : { "type" : "string", "description" : "This is a requested price from the customer. Pre-approval is necessary before using this feature. A methodology called price variance to manage requested pricing needs to be setup in advance by your sales rep.\n\nIf unit price is provided without this advanced setup the unit price will be ignored and standard Ingram Micro pricing will apply." }, "enduser" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "addressline1" : { "type" : "string" }, "addressline2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "postalcode" : { "type" : "string" }, "countrycode" : { "type" : "string" }, "phonenumber" : { "type" : "string" }, "extensionnumber" : { "type" : "string" }, "faxnumber" : { "type" : "string" }, "email" : { "type" : "string", "format" : "email" } } }, "productextendedspecs" : { "type" : "object", "properties" : { "attributename" : { "type" : "string", "enum" : [ "shipfrom", "specialprice", "authbidnumber", "commenttext", "serialnumber", "contactnumber", "shipnotestxt" ] }, "attributevalue" : { "type" : "string" } } } }, "required" : [ "ingrampartnumber", "quantity" ] } }, "extendedspecs" : { "type" : "object", "description" : "Attribute Name and Value: This field identifies if your order is a DIRECT SHIP order (license / warranty) or how you want your Backorders managed as well as other process options like placing your order on hold or adding a comment. ", "properties" : { "attributename" : { "type" : "string", "enum" : [ "Isdirectshiporder", "emailaddress", "Isbackorderflagallowed", "placeoncustomerhold", "signaturerequired", "commenttext", "resellerctacemail", "duplicatecustomerordernumbervalidate", "quotenumber", "shipctacphone", "vendauthnumber", "continueonerror" ] }, "attributevalue" : { "type" : "string" } } } }, "required" : [ "customerponumber", "ordertype", "shiptoaddress", "lines" ] } }, "required" : [ "requestpreamble" ] } } }, "QuoteProductList" : { "title" : "quoteProductList", "type" : "object", "x-tags" : [ "quotes" ], "properties" : { "quoteProductGuid" : { "type" : "string" }, "quantity" : { "type" : "string" }, "comments" : { "type" : "string" }, "bidStartDate" : { "type" : "string" }, "bidExpiryDate" : { "type" : "string" }, "sku" : { "type" : "string" }, "lineNumber" : { "type" : "string" }, "description" : { "type" : "string" }, "vendorPartNumber" : { "type" : "string" }, "weight" : { "type" : "string" }, "isSuggestionProduct" : { "type" : "string" }, "vpnCategory" : { "type" : "string" }, "quoteProductsSupplierPartAuxiliaryId" : { "type" : "string" }, "quoteProductsVendor" : { "type" : "string" }, "price" : { "type" : "object", "properties" : { "quotePrice" : { "type" : "number" }, "msrp" : { "type" : "number" }, "extendedMsrp" : { "type" : "number" }, "extendedQuotePrice" : { "type" : "number" } } } } }, "quoteDetailsResponse" : { "title" : "quoteDetailsResponse", "type" : "object", "x-tags" : [ "quotes" ], "properties" : { "quoteDetailResponse" : { "type" : "object", "properties" : { "responsePreamble" : { "type" : "object", "properties" : { "responseStatus" : { "type" : "string" }, "statusCode" : { "type" : "string" }, "responseMessage" : { "type" : "string" } } }, "retrieveQuoteResponse" : { "type" : "object", "properties" : { "quoteGuid" : { "type" : "string" }, "quoteName" : { "type" : "string" }, "quoteNumber" : { "type" : "string" }, "quoteExpiryDate" : { "type" : "string" }, "revisionNumber" : { "type" : "string" }, "introPreamble" : { "type" : "string" }, "purchaseInstructions" : { "type" : "string" }, "legalTerms" : { "type" : "string" }, "currencyCode" : { "type" : "string" }, "priceDeviationId" : { "type" : "string" }, "priceDeviationStartDate" : { "type" : "string" }, "priceDeviationExpiryDate" : { "type" : "string" }, "customerNeed" : { "type" : "string" }, "solutionProposed" : { "type" : "string" }, "status" : { "type" : "string" }, "created" : { "type" : "string" }, "modified" : { "type" : "string" }, "leasingCalculations" : { "type" : "string" }, "leasingInstructions" : { "type" : "string" }, "accountInfo" : { "type" : "object", "properties" : { "accountName" : { "type" : "string" }, "bcn" : { "type" : "string" }, "phone" : { "type" : "string" } } }, "contactInfo" : { "type" : "object", "properties" : { "contactEmail" : { "type" : "string" }, "contactName" : { "type" : "string" } } }, "vendorAttributes" : { "type" : "object", "properties" : { "estimateId" : { "type" : "string" }, "dealId" : { "type" : "string" }, "vendorName" : { "type" : "string" }, "vendorSettingMessage" : { "type" : "string" } } }, "endUser" : { "type" : "object", "properties" : { "endUserName" : { "type" : "string" }, "endUserAddress" : { "type" : "string" }, "endUserAddress2" : { "type" : "string" }, "endUserAddress3" : { "type" : "string" }, "endUserCity" : { "type" : "string" }, "endUserState" : { "type" : "string" }, "endUserEmail" : { "type" : "string" }, "endUserPhone" : { "type" : "string" }, "endUserZipCode" : { "type" : "string" }, "endUserContactName" : { "type" : "string" }, "endUserMarketSegment" : { "type" : "string" } } }, "quoteProductList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/quoteProductList" } }, "totalQuoteProductCount" : { "type" : "string" }, "totalExtendedMsrp" : { "type" : "string" }, "totalQuantity" : { "type" : "string" }, "totalExtendedQuotePrice" : { "type" : "string" } } } } } } }, "QuoteToOrderDetailsDTO" : { "type" : "object", "properties" : { "quoteNumber" : { "type" : "string", "maxLength" : 35, "description" : "A unique identifier generated by Ingram Micro's CRM specific to each quote.", "nullable" : true }, "customerOrderNumber" : { "type" : "string", "maxLength" : 35, "description" : "The reseller's order number for reference in their system.", "nullable" : true }, "enduserOrderNumber" : { "type" : "string", "maxLength" : 35, "description" : "The end customer's order number for reference in their system.", "nullable" : true }, "billToAddressId" : { "type" : "string", "description" : "Suffix used to identify billing address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit.", "nullable" : true }, "endUserInfo" : { "type" : "array", "description" : "The contact information for the end user/customer provided by the reseller. Used to determine pricing and discounts.", "items" : { "type" : "object", "properties" : { "companyName" : { "type" : "string", "description" : "The company name for the end user/customer." }, "contact" : { "type" : "string", "description" : "The contact name for the end user/customer." }, "addressLine1" : { "type" : "string", "description" : "The address line 1 for the end user/customer." }, "addressLine2" : { "type" : "string", "description" : "The address line 2 for the end user/customer." }, "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", "description" : "The end user/customer's two character ISO country code." }, "email" : { "type" : "string", "description" : "The end user/customer's phone number." }, "phoneNumber" : { "type" : "string", "description" : "The end user/customer's phone number." } } } }, "shipToInfo" : { "type" : "array", "description" : "The shipping information provided by the reseller for order delivery.", "items" : { "type" : "object", "properties" : { "addressId" : { "type" : "string", "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "description" : "The reseller's company name or the End-User's Name" }, "contact" : { "type" : "string", "description" : "The contact name for the order will be shipped to." }, "addressLine1" : { "type" : "string", "description" : "The address line 1 the order will be shipped to." }, "addressLine2" : { "type" : "string", "description" : "The address line 2 the order will be shipped to." }, "city" : { "type" : "string", "description" : "The city the order will be shipped to." }, "state" : { "type" : "string", "description" : "The state the order will be shipped to." }, "postalCode" : { "type" : "string", "description" : "The zip or postal code the order will be shipped to." }, "countryCode" : { "type" : "string", "description" : "The two-character ISO country code the order will be shipped to." }, "email" : { "type" : "string", "description" : "The company contact email address.", "nullable" : true } } } }, "additionalAttributes" : { "type" : "array", "description" : "Additional order create attributes.", "items" : { "properties" : { "attributeName" : { "type" : "string", "description" : "The attribute name. allowDuplicateCustomerOrderNumber: Allow orders with duplicate customer PO numbers. Enables resellers to have the same PO number for multiple orders. enableCommentsAsLines: It will enable comments as lines." }, "attributeValue" : { "type" : "string", "description" : "The attribute field data." } } } }, "vmfadditionalAttributes" : { "type" : "array", "description" : "The object containing the list of fields required at a header level by the vendor.", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "The name of the header level field." }, "attributeValue" : { "type" : "string", "description" : "The value of the header level field." }, "attributeDescription" : { "type" : "string", "description" : "The description of the header level field." } }, "additionalProperties" : false } }, "lines" : { "type" : "array", "description" : "The object containing the lines that require vendor mandatory fields.", "items" : { "type" : "object", "properties" : { "customerLineNumber" : { "type" : "string", "description" : "The reseller's line item number for reference in their system." }, "ingramPartNumber" : { "type" : "string", "description" : "Unique IngramMicro part number." }, "quantity" : { "type" : "string", "description" : "The quantity of the line item." }, "vmfAdditionalAttributesLines" : { "type" : "array", "description" : "The object containing the list of fields required at a line level by the vendor.", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "The name of the line level field." }, "attributeValue" : { "type" : "string", "description" : "The value of the line level field." }, "attributeDescription" : { "type" : "string", "description" : "The description of the line level field." } } } } } } } }, "additionalProperties" : false }, "QuoteToOrderResponse" : { "type" : "object", "properties" : { "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote.", "example" : "QUO-14551943-D2Y9L9" }, "confirmationNumber" : { "type" : "number", "example" : 987654322, "description" : "A unique confirmation number for tracking purposes." }, "message" : { "type" : "string", "description" : "A confirmation message." } } }, "QuoteDetailsRequest" : { "title" : "quoteDetailsRequest", "type" : "object", "properties" : { "quoteProductsRequest" : { "type" : "object", "properties" : { "requestpreamble" : { "type" : "object", "properties" : { "customerNumber" : { "type" : "string", "description" : "Reseller Number (referred to as the account BCN) is the unique identifier for an Ingram Micro customer account." }, "isoCountryCode" : { "type" : "string", "description" : "The ISO country codes are internationally recognized codes designated for each country represented by a two-letter combination (alpha-2)." } }, "required" : [ "customerNumber", "isoCountryCode" ] }, "retrieveQuoteProductsRequest" : { "type" : "object", "properties" : { "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes." }, "thirdPartySource" : { "type" : "string", "description" : "Unique identifier used to identify the third party source accessing the services." } } } } } }, "x-examples" : { "Example" : { "quoteProductsRequest" : { "requestPreamble" : { "customerNumber" : "20-222222", "isoCountryCode" : "US" }, "retrieveQuoteProductsRequest" : { "quoteNumber" : "QUO-04959-C3V6L4", "thirdPartySource" : "3RDPIDCONWISE" } } } }, "description" : "Request schema for get quote details endpoint", "x-tags" : [ "quotes" ] }, "QuoteListResponse" : { "title" : "quoteListResponse", "type" : "object", "x-examples" : { "Example" : { "quoteSearchResponse" : { "responsePreamble" : { "responseStatus" : "Passed", "responseStatusCode" : "200", "responseMessage" : "Records Found" }, "quotelist" : [ { "quoteGuid" : "dbabb2a5-02ea-e911-a97b-000d3a30e34c", "quoteName" : "TEST-9771006-1920_CW EndUser11", "quoteNumber" : "QUO-11048-S9P1R3", "revisionNumber" : 0, "endUserName" : "CW EndUser11", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "ec14fd96-02ea-e911-a98d-000d3a30e941", "quoteName" : "TEST-9771006-1920_CW EndUser12", "quoteNumber" : "QUO-11047-M1K1Z6", "revisionNumber" : 0, "endUserName" : "CW EndUser12", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "f3d7d186-02ea-e911-a98d-000d3a30e941", "quoteName" : "TEST-9771006-1920_CW EndUser10", "quoteNumber" : "QUO-11045-G1X9S8", "revisionNumber" : 0, "endUserName" : "CW EndUser10", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "43ae3e7f-02ea-e911-a97a-000d3a30eb04", "quoteName" : "TEST-9771006-1920_CW EndUser9", "quoteNumber" : "QUO-11044-V2F8F9", "revisionNumber" : 0, "endUserName" : "CW EndUser9", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" }, { "quoteGuid" : "88062b6f-02ea-e911-a97a-000d3a30eb04", "quoteName" : "TEST-9771006-1920_CW EndUser8", "quoteNumber" : "QUO-11043-W2X1T5", "revisionNumber" : 0, "endUserName" : "CW EndUser8", "bidNumber" : "TEST-9771006-1920", "totalAmount" : "60766.2", "quoteStatus" : "Active", "createdDate" : "2019-10-08", "lastModifiedDate" : "2019-10-08", "quoteExpiryDate" : "0001-01-01" } ], "totalCount" : 5 } } }, "properties" : { "quoteSearchResponse" : { "type" : "object", "properties" : { "responsePreamble" : { "type" : "object", "properties" : { "responseStatus" : { "type" : "string", "description" : "Status of the Request - \"Passed\", \"Failed\"" }, "responseStatusCode" : { "type" : "string", "description" : "responseStatusCode is the code returned in response to a request. The following Codes are returned: 200 400 500" }, "responseMessage" : { "type" : "string", "description" : "200 = Action was successfully received, understood and accepted. 400 = The request contains bad syntax or can not be fullfilled. This means there is a problem with the request. 500 = The server failed to fulfill an apparently valid request. This is a temporary problem, the request should be resubmitted." } } }, "quoteList" : { "type" : "array", "items" : { "type" : "object", "properties" : { "quoteGuid" : { "type" : "string", "description" : "Quote GUID is the primary quote key in Ingram Micro's CRM - needed to retrieve quote details." }, "quoteName" : { "type" : "string", "description" : "Quote Name given to quote by sales team or system generated. Generally used as a reference to identify the quote." }, "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes." }, "revisionNumber" : { "type" : "string", "description" : "When a quote has been revised and updated, the quote number remains the same throughout the lifecycle of the quote, however, a Revision number is updated for each revision of the quote. The revision numbers is associated with the Unique Quote Number." }, "endUserName" : { "type" : "string", "description" : "End User Name is the end customer name that is associated with a quote in Ingram Micro's CRM" }, "bidNumber" : { "type" : "string", "description" : "Special Pricing Bid Number, also refers to as Dart Number relates to a unique pricing deal associated with a vendor for the quote." }, "totalAmount" : { "type" : "string", "description" : "Total amount of quoted price for all products in the quote." }, "quoteStatus" : { "type" : "string", "description" : "This refers to the primary status of the quote. API responses will return: Active" }, "createdDate" : { "type" : "string", "description" : "Date the Quote was initially Created", "format" : "date" }, "lastModifiedDate" : { "type" : "string", "description" : "Date the Quote was last updated or modified.", "format" : "date" }, "quoteExpiryDate" : { "type" : "string", "description" : "Date the Quote Expires", "format" : "date" } } } }, "totalCount" : { "type" : "integer", "description" : "Total count of quotes retrieved in the request response." } } } }, "description" : "Response schema for get quote list endpoint", "x-tags" : [ "quotes" ] }, "QuoteListRequest" : { "title" : "quoteListRequest", "type" : "object", "x-examples" : { "Example" : { "quoteSearchRequest" : { "requestPreamble" : { "customerNumber" : "20-222222", "customerContact" : "user.name@ingrampartner.com", "isoCountryCode" : "US" }, "retrieveQuoteRequest" : { "quoteNumber" : "QUO-02973-V6H8R6", "bidNumber" : "MDMF-1199371-1811", "endUserName" : "CARESOURCE MANAGEMENT GROUP CO.", "quoteStatus" : "3", "fromDate" : "2019-09-01", "toDate" : "2019-09-11", "pageIndex" : 1, "recordsPerPage" : 25, "sorting" : "desc", "sortingColumnName" : "createdon", "thirdPartySource" : "3RDPIDCONWISE" } } } }, "properties" : { "quoteSearchRequest" : { "type" : "object", "properties" : { "requestPreamble" : { "type" : "object", "properties" : { "customerNumber" : { "type" : "string", "description" : "Reseller Number (referred to as the account BCN) is the unique identifier for an Ingram Micro customer account.", "maxLength" : 10 }, "customerContact" : { "type" : "string", "description" : "Logged in User's email address.", "format" : "email" }, "isoCountryCode" : { "type" : "string", "description" : "The ISO country codes are internationally recognized codes designated for each country represented by a two-letter combination (alpha-2).", "maxLength" : 3 } }, "required" : [ "customerNumber", "customerContact", "isoCountryCode" ] }, "retrieveQuoteRequest" : { "type" : "object", "properties" : { "quoteNumber" : { "type" : "string", "description" : "Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes.", "maxLength" : 100 }, "bidNumber" : { "type" : "string", "description" : "Special Pricing Bid Number, also referred to as a Dart Number by some vendors, is a unique identifier associated with vendor specific products and discounts.", "maxLength" : 100 }, "endUserName" : { "type" : "string", "description" : "End User Name is the end customer name that is associated with a quote in Ingram Micro's CRM", "maxLength" : 300 }, "fromDate" : { "type" : "string", "description" : "Filter to select the beginning date of a desired date range. The default filter is set to the date the user is logged-in to request quotes. Date format: YYYY-MM-DD - An incorrect date input will result in a message \"Date must be entered as YYYY-MM-DD\"", "format" : "date", "example" : "2019-06-21" }, "toDate" : { "type" : "string", "description" : "Filter to select the end date of a desired date range. The default number of days to request is the previous 30 days from the date user has logged in. Date format: YYYY-MM-DD - An incorrect date input will result in a message \"Date must be entered as YYYY-MM-DD\"", "format" : "date", "example" : "2019-06-21" }, "pageIndex" : { "type" : "string", "description" : "Page index or page number for the list of quotes being returned. When less than 25 quotes are returned, the page number will be \"1\". In cases where more than 25 quotes are returned, and the default quotes per page are 25 (see recordPerPage), then the list will continue on subsequent pages." }, "recordsPerPage" : { "type" : "string", "description" : "Number of records (quotes) to display per page in the quote list. The default is 25, but may be increased using the filter by up to 100 records per page. If more than 100 records are requested a message will be returned \"The number of records requested exceeds the 100 record limit.\"\t" }, "sorting" : { "type" : "string", "description" : "Sort applies to the selected column (sortingColumnName) and may be specified in Ascending (asc) or Descending (desc) order. The default sort is Descending (desc) - most recent first.", "enum" : [ "asc", "desc" ] }, "sortingColumnName" : { "type" : "string", "description" : "Refers to the column selected to apply the sorting criteria. The default column is dateCreated and will sort by the most recently created quote first with the following in descending order. The default filter retrieves quotes created within the last 30 days. Filtering allows user to select a specific column to sort: quoteNumber, createdDate, lastModifiedDate, expiryDate, and endUserName.", "example" : "toDate", "maxLength" : 100 }, "thirdPartySource" : { "type" : "string", "description" : "Unique identifier used to identify the third party source accessing the services.", "maxLength" : 100 } } } } } }, "description" : "Request schema for get quote list endpoint", "x-tags" : [ "quotes" ] }, "AdditionalAttribute" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "Line level custom field names." }, "attributeValue" : { "type" : "string", "description" : "Value of the custom fields." } }, "additionalProperties" : false }, "CarrierDetailB2B" : { "type" : "object", "properties" : { "carrierCode" : { "type" : "string", "description" : "The carrier code for the shipment containing the line item." }, "carrierName" : { "type" : "string", "description" : "The name of the carrier of the shipment containing the line item." }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "The quantity shipped of the line item." }, "shippedDate" : { "type" : "string", "description" : "The actual date when line item shipped." }, "estimatedDeliveryDate" : { "type" : "string", "description" : "The date the line item is expected to be delivered." }, "deliveredDate" : { "type" : "string", "description" : "The actual date of delivery of the line item." }, "carrierPickupDate" : { "type" : "string", "description" : "The actual date when carrier picked up line item." }, "trackingDetails" : { "type" : "array", "description" : "The tracking details for the shipment containing the line item.", "items" : { "$ref" : "#/components/schemas/TrackingDetailB2B" }, "nullable" : true } }, "additionalProperties" : false }, "Contractinfo" : { "type" : "object", "properties" : { "contractDescription" : { "type" : "string", "description" : "The description of the contract." }, "contractNumber" : { "type" : "string", "description" : "Contract number." }, "contractStatus" : { "type" : "string", "description" : "The status of the contract." }, "contractStartDate" : { "type" : "string", "description" : "Start date of the contract." }, "contractEndDate" : { "type" : "string", "description" : "End date of the contract." }, "contractDuration" : { "type" : "string", "description" : "The duration of the contract." } }, "additionalProperties" : false }, "Error" : { "type" : "object", "properties" : { "id" : { "type" : "string", "nullable" : true }, "type" : { "type" : "string", "nullable" : true }, "message" : { "type" : "string", "nullable" : true }, "fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Fields" }, "nullable" : true } }, "additionalProperties" : false }, "ErrorResponseDTO" : { "type" : "object", "properties" : { "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Error" }, "nullable" : true } }, "additionalProperties" : false }, "Fields" : { "type" : "object", "properties" : { "field" : { "type" : "string", "nullable" : true }, "message" : { "type" : "string", "nullable" : true }, "value" : { "type" : "string", "nullable" : true } }, "additionalProperties" : false }, "LicenseInfo" : { "type" : "object", "properties" : { "licenseNumber" : { "type" : "array", "description" : "License numbers.", "items" : { "type" : "string" }, "nullable" : true }, "licenseStartDate" : { "type" : "string", "description" : "Start Date of the license." }, "licenseEndDate" : { "type" : "string", "description" : "End Date of the license." }, "description" : { "type" : "string", "description" : "Description of the license." }, "quantity" : { "type" : "string", "description" : "Quantity of the license." } }, "additionalProperties" : false }, "LineB2B" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "ingramOrderLineNumber" : { "type" : "string", "description" : "Unique Ingram Micro line number. Starts with 001." }, "vendorSalesOrderLineNumber" : { "type" : "string", "description" : "The vendor's sales order line number." }, "customerLineNumber" : { "type" : "string", "description" : "The reseller's line item number for reference in their system." }, "lineStatus" : { "type" : "string", "description" : "The status for the line item in the order. One of- Backordered, In Progress, Shipped, Delivered, Canceled, On Hold." }, "ingramPartNumber" : { "type" : "string", "description" : "Unique IngramMicro part number." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor's part number for the line item." }, "vendorName" : { "type" : "string", "description" : "The vendor's name for the part in their system." }, "partDescription" : { "type" : "string", "description" : "The vendor's description of the part in their system." }, "unitWeight" : { "type" : "number", "format" : "double", "description" : "The unit weight of the line item." }, "weightUom" : { "type" : "string", "description" : "The unit of measure for the line item." }, "unitPrice" : { "type" : "number", "format" : "double", "description" : "The unit price of the line item." }, "upcCode" : { "type" : "string", "default" : "", "description" : "The UPC code of a product." }, "extendedPrice" : { "type" : "number", "format" : "double", "description" : "Unit price X quantity for the line item." }, "taxAmount" : { "type" : "number", "format" : "double", "description" : "The tax amount for the line item." }, "currencyCode" : { "type" : "string", "description" : "The country-specific three character ISO 4217 currency code for the line item." }, "quantityOrdered" : { "type" : "integer", "format" : "int32", "description" : "The quantity ordered of the line item." }, "quantityConfirmed" : { "type" : "integer", "format" : "int32", "description" : "The quantity confirmed for the line item." }, "quantityBackOrdered" : { "type" : "integer", "format" : "int32", "description" : "The quantity backordered for the line item." }, "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 in the case of split orders or where different line items have different bid numbers. Line-level bid numbers take precedence over header-level bid numbers." }, "requestedDeliverydate" : { "type" : "string", "default" : "", "description" : "Reseller-requested delivery date. Delivery date is not guaranteed." }, "promisedDeliveryDate" : { "type" : "string", "default" : "", "description" : "The delivery date promised by IngramMicro." }, "lineNotes" : { "type" : "string", "default" : "", "description" : "Line-level notes for the order." }, "shipmentDetails" : { "type" : "array", "description" : "Shipping details for the line item.", "items" : { "$ref" : "#/components/schemas/ShipmentDetailB2B" }, "nullable" : true }, "serviceContractInfo" : { "$ref" : "#/components/schemas/Servicecontractinfo" }, "additionalAttributes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdditionalAttribute" }, "nullable" : true }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Link" }, "nullable" : true } }, "additionalProperties" : false }, "Link" : { "type" : "object", "description" : "Link to Order Details for the line item.", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the line item." }, "href" : { "type" : "string", "description" : "The API endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link(GET,POST etc)." } }, "additionalProperties" : false }, "MiscellaneousChargeB2BDto" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "chargeLineReference" : { "type" : "string", "description" : "Impulse line number for the miscellaneous charge." }, "chargeDescription" : { "type" : "string", "description" : "Description of the miscellaneous charges." }, "chargeAmount" : { "type" : "string", "description" : "The amount of miscellaneous charges." } }, "additionalProperties" : false }, "OrderDetailB2B" : { "type" : "object", "properties" : { "ingramOrderNumber" : { "type" : "string", "description" : "The IngramMicro sales order number." }, "ingramOrderDate" : { "type" : "string", "format" : "date-time", "description" : "The IngramMicro sales order date." }, "orderType" : { "type" : "string", "description" : "The IngramMicro sales order type." }, "customerOrderNumber" : { "type" : "string", "description" : "The reseller's order number for reference in their system." }, "endCustomerOrderNumber" : { "type" : "string", "description" : "The end customer's order number for reference in their system." }, "webOrderId" : { "type" : "string", "description" : "The web order id of the order." }, "vendorSalesOrderNumber" : { "type" : "string", "description" : "The vendor's order number for reference in their system" }, "ingramPurchaseOrderNumber" : { "type" : "string", "description" : "Ingram purchase order number." }, "orderStatus" : { "type" : "string", "description" : "The header-level status of the order. One of- Shipped, Canceled, Backordered, Processing, On Hold, Delivered." }, "orderTotal" : { "type" : "number", "format" : "double", "description" : "The total cost for the order, includes subtotal, freight charges, and tax." }, "orderSubTotal" : { "type" : "number", "format" : "double", "description" : "The sub total cost for the order, not including tax and freight." }, "freightCharges" : { "type" : "number", "format" : "double", "description" : "The freight charges for the order." }, "currencyCode" : { "type" : "string", "description" : "The country-specific three digit ISO 4217 currency code for the order." }, "totalWeight" : { "type" : "number", "format" : "double", "description" : "Total order weight. unit -- North america - Pounds , other countries will be KG." }, "totalTax" : { "type" : "number", "format" : "double", "description" : "Total tax on the orders placed." }, "paymentTerms" : { "type" : "string", "description" : "The payment terms of the order. (Ex- Net 30 days)." }, "notes" : { "type" : "string", "description" : "The header-level notes for the order." }, "billToInfo" : { "type" : "object", "description" : "The billing information provided by the reseller.", "properties" : { "contact" : { "type" : "string", "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "description" : "The name of the company the order will be billed to." }, "addressLine1" : { "type" : "string", "description" : "The address line 1 the order will be billed to." }, "addressLine2" : { "type" : "string", "description" : "The address line 2 the order will be billed to." }, "city" : { "type" : "string", "description" : "The city the order will be billed to." }, "state" : { "type" : "string", "description" : "The state the order will be billed to." }, "postalCode" : { "type" : "string", "description" : "The zip or postal code the order will be billed to." }, "countryCode" : { "type" : "string", "description" : "The two-character ISO country code the order will be billed to." }, "phoneNumber" : { "type" : "string", "description" : "The company contact phone number." }, "email" : { "type" : "string", "description" : "The company contact email address." } }, "additionalProperties" : false }, "shipToInfo" : { "type" : "object", "description" : "The shipping information provided by the reseller for order delivery.", "properties" : { "contact" : { "type" : "string", "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "description" : "The reseller's company name or the End-User's Name" }, "addressLine1" : { "type" : "string", "description" : "The address line 1 the order will be shipped to." }, "addressLine2" : { "type" : "string", "description" : "The address line 2 the order will be shipped to." }, "city" : { "type" : "string", "description" : "The city the order will be shipped to." }, "state" : { "type" : "string", "description" : "The state the order will be shipped to." }, "postalCode" : { "type" : "string", "description" : "The zip or postal code the order will be shipped to." }, "countryCode" : { "type" : "string", "description" : "The two-character ISO country code the order will be shipped to." }, "phoneNumber" : { "type" : "string", "description" : "The company contact phone number." }, "email" : { "type" : "string", "description" : "The company contact email address." } }, "additionalProperties" : false }, "endUserInfo" : { "type" : "object", "description" : "The contact information for the end user/customer provided by the reseller. Used to determine pricing and discounts.", "properties" : { "contact" : { "type" : "string", "description" : "The contact name for the end user/customer." }, "companyName" : { "type" : "string", "description" : "The company name for the end user/customer." }, "addressLine1" : { "type" : "string", "description" : "The address line 1 for the end user/customer." }, "addressLine2" : { "type" : "string", "description" : "The address line 2 for the end user/customer." }, "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", "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." } }, "additionalProperties" : false }, "lines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "ingramOrderLineNumber" : { "type" : "string", "description" : "Unique Ingram Micro line number. Starts with 001." }, "vendorSalesOrderLineNumber" : { "type" : "string", "description" : "The vendor's sales order line number." }, "customerLineNumber" : { "type" : "string", "description" : "The reseller's line item number for reference in their system." }, "lineStatus" : { "type" : "string", "description" : "The status for the line item in the order. One of- Backordered, In Progress, Shipped, Delivered, Canceled, On Hold." }, "ingramPartNumber" : { "type" : "string", "description" : "Unique IngramMicro part number." }, "vendorPartNumber" : { "type" : "string", "description" : "The vendor's part number for the line item." }, "vendorName" : { "type" : "string", "description" : "The vendor's name for the part in their system." }, "partDescription" : { "type" : "string", "description" : "The vendor's description of the part in their system." }, "unitWeight" : { "type" : "number", "format" : "double", "description" : "The unit weight of the line item." }, "weightUom" : { "type" : "string", "description" : "The unit of measure for the line item." }, "unitPrice" : { "type" : "number", "format" : "double", "description" : "The unit price of the line item." }, "upcCode" : { "type" : "string", "description" : "The UPC code of a product." }, "extendedPrice" : { "type" : "number", "format" : "double", "description" : "Unit price X quantity for the line item." }, "taxAmount" : { "type" : "number", "format" : "double", "description" : "The tax amount for the line item." }, "currencyCode" : { "type" : "string", "description" : "The country-specific three character ISO 4217 currency code for the line item." }, "quantityOrdered" : { "type" : "integer", "format" : "int32", "description" : "The quantity ordered of the line item." }, "quantityConfirmed" : { "type" : "integer", "format" : "int32", "description" : "The quantity confirmed for the line item." }, "quantityBackOrdered" : { "type" : "integer", "format" : "int32", "description" : "The quantity backordered for the line item." }, "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 in the case of split orders or where different line items have different bid numbers. Line-level bid numbers take precedence over header-level bid numbers." }, "requestedDeliverydate" : { "type" : "string", "description" : "Reseller-requested delivery date. Delivery date is not guaranteed." }, "promisedDeliveryDate" : { "type" : "string", "description" : "The delivery date promised by IngramMicro." }, "lineNotes" : { "type" : "string", "description" : "Line-level notes for the order." }, "shipmentDetails" : { "type" : "array", "description" : "Shipping details for the line item.", "items" : { "type" : "object", "properties" : { "quantity" : { "type" : "integer", "format" : "int32", "description" : "The quantity shipped of the line item." }, "deliveryNumber" : { "type" : "string", "description" : "The actual date of delivery of the line item." }, "estimatedShipDate" : { "type" : "string", "description" : "The date the line item is expected to be shipped." }, "shipFromWarehouseId" : { "type" : "string", "description" : "The ID of the warehouse the product will ship from." }, "shipFromLocation" : { "type" : "string", "description" : "The city and state the line item ships from." }, "invoiceNumber" : { "type" : "string", "description" : "The Ingram Micro invoice number for the line item." }, "invoiceDate" : { "type" : "string", "description" : "The date the IngramMicro invoice was created for the line item." }, "carrierDetails" : { "type" : "array", "description" : "The shipment carrier details for the line item.", "items" : { "type" : "object", "properties" : { "carrierCode" : { "type" : "string", "description" : "The carrier code for the shipment containing the line item." }, "carrierName" : { "type" : "string", "description" : "The name of the carrier of the shipment containing the line item." }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "The quantity shipped of the line item." }, "shippedDate" : { "type" : "string", "description" : "The actual date when line item shipped." }, "estimatedDeliveryDate" : { "type" : "string", "description" : "The date the line item is expected to be delivered." }, "deliveredDate" : { "type" : "string", "description" : "The actual date of delivery of the line item." }, "carrierPickupDate" : { "type" : "string", "description" : "The actual date when carrier picked up line item." }, "trackingDetails" : { "type" : "array", "description" : "The tracking details for the shipment containing the line item.", "items" : { "type" : "object", "properties" : { "trackingNumber" : { "type" : "string", "description" : "The tracking number for the shipment containing the line item." }, "trackingUrl" : { "type" : "string", "description" : "The tracking URL for the shipment containing the line item." }, "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." }, "quantityInBox" : { "type" : "string", "description" : "The quantity of line items in the box." }, "serialNumbers" : { "type" : "array", "description" : "A list of serial numbers of the line items contained in the shipment.", "items" : { "type" : "object", "properties" : { "serialNumber" : { "type" : "string", "description" : "The serial number for the line item." } }, "additionalProperties" : false }, "nullable" : true } }, "additionalProperties" : false }, "nullable" : true } }, "additionalProperties" : false }, "nullable" : true } }, "additionalProperties" : false }, "nullable" : true }, "serviceContractInfo" : { "type" : "object", "properties" : { "contractInfo" : { "type" : "object", "properties" : { "contractDescription" : { "type" : "string", "description" : "The description of the contract." }, "contractNumber" : { "type" : "string", "description" : "Contract number." }, "contractStatus" : { "type" : "string", "description" : "The status of the contract." }, "contractStartDate" : { "type" : "string", "description" : "Start date of the contract." }, "contractEndDate" : { "type" : "string", "description" : "End date of the contract." }, "contractDuration" : { "type" : "string", "description" : "The duration of the contract." } }, "additionalProperties" : false }, "subscriptions" : { "type" : "object", "properties" : { "subscriptionId" : { "type" : "string", "description" : "The ID of the subscription." }, "subscriptionTerm" : { "type" : "string", "description" : "The term of the subscription." }, "renewalTerm" : { "type" : "string", "description" : "The renewal term of the subscription." }, "billingModel" : { "type" : "string", "description" : "The billing model of the billing." }, "subcriptionStartDate" : { "type" : "string", "description" : "Start date of the subcription." }, "subcriptionEndDate" : { "type" : "string", "description" : "End date of the subcription." } }, "additionalProperties" : false }, "licenseInfo" : { "type" : "object", "properties" : { "licenseNumber" : { "type" : "array", "description" : "License numbers.", "items" : { "type" : "string" }, "nullable" : true }, "licenseStartDate" : { "type" : "string", "description" : "Start Date of the license." }, "licenseEndDate" : { "type" : "string", "description" : "End Date of the license." }, "description" : { "type" : "string", "description" : "Description of the license." }, "quantity" : { "type" : "string", "description" : "Quantity of the license." } }, "additionalProperties" : false } }, "additionalProperties" : false }, "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." } }, "additionalProperties" : false }, "nullable" : true }, "links" : { "type" : "array", "items" : { "type" : "object", "description" : "Link to Order Details for the line item.", "properties" : { "topic" : { "type" : "string", "description" : "Provides the details of the line item." }, "href" : { "type" : "string", "description" : "The API endpoint for accessing the relevant data." }, "type" : { "type" : "string", "description" : "The type of call that can be made to the href link(GET,POST etc)." } }, "additionalProperties" : false }, "nullable" : true }, "estimatedDates" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ship" : { "type" : "object", "properties" : { "shipDateType" : { "type" : "string", "description" : "Date type. Example Single or multiple dates." }, "shipDateRange" : { "type" : "object", "properties" : { "startDate" : { "type" : "string", "description" : "Start Date." }, "endDate" : { "type" : "string", "description" : "End Date." } } }, "shipSource" : { "type" : "string", "description" : "Source of the shipment." }, "shipDescription" : { "type" : "string", "description" : "Shipment description." }, "shipDate" : { "type" : "string", "description" : "Ship date." } } }, "delivery" : { "type" : "object", "properties" : { "deliveryDateType" : { "type" : "string", "description" : "Date type. Example Single or multiple dates." }, "deliveryDateRange" : { "description" : "Delivery date range.", "properties" : { "startDate" : { "type" : "string", "description" : "Start Date." }, "endDate" : { "type" : "string", "description" : "End Date." } } }, "deliverySource" : { "type" : "string", "description" : "Source of the delivery." }, "deliveryDescription" : { "type" : "string", "description" : "Delivery description." }, "deliveredDate" : { "type" : "string", "description" : "Delivery date." } } } } } }, "scheduleLines" : { "type" : "array", "items" : { "type" : "object", "properties" : { "lineNumber" : { "type" : "string", "description" : "Line number." }, "scheduleLineDate" : { "type" : "string", "description" : "schedule Line Date." }, "requestedQuantity" : { "type" : "string", "description" : "Requested quantity." }, "confirmedQuantity" : { "type" : "string", "description" : "Confirmed quantity." }, "goodsIssueDate" : { "type" : "string", "description" : "Date when good issued." } } } }, "multipleShipments" : { "type" : "array", "items" : { "type" : "object", "properties" : { "lineNumber" : { "type" : "string", "description" : "Line number." }, "requestedQuantity" : { "type" : "string", "description" : "Requested quantity." }, "confirmedQuantity" : { "type" : "string", "description" : "Confirmed quantity." }, "dataType" : { "type" : "string", "description" : "Date type. Example Single or multiple dates." }, "dateRange" : { "type" : "object", "properties" : { "startDate" : { "type" : "string", "description" : "Start Date." }, "endDate" : { "type" : "string", "description" : "End Date." } } }, "source" : { "type" : "string", "description" : "Source." }, "description" : { "type" : "string", "description" : "Description." }, "date" : { "type" : "string", "description" : "Date." }, "deliveryDate" : { "type" : "string", "description" : "Delivery date." } } } } }, "additionalProperties" : false }, "nullable" : true }, "miscellaneousCharges" : { "type" : "array", "items" : { "type" : "object", "properties" : { "subOrderNumber" : { "type" : "string", "description" : "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "chargeLineReference" : { "type" : "string", "description" : "Impulse line number for the miscellaneous charge." }, "chargeDescription" : { "type" : "string", "description" : "Description of the miscellaneous charges." }, "chargeAmount" : { "type" : "string", "description" : "The amount of miscellaneous charges." } }, "additionalProperties" : false }, "nullable" : true }, "additionalAttributes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "Header level custom field names." }, "attributeValue" : { "type" : "string", "description" : "Value of the custom fields." } }, "additionalProperties" : false }, "nullable" : true } }, "additionalProperties" : false }, "OrderDetailB2BAddressDto" : { "type" : "object", "properties" : { "contact" : { "type" : "string", "description" : "The company contact provided by the reseller." }, "companyName" : { "type" : "string", "description" : "The name of the company the order will be billed to." }, "addressLine1" : { "type" : "string", "description" : "The address line 1 the order will be billed to." }, "addressLine2" : { "type" : "string", "default" : "", "description" : "The address line 2 the order will be billed to." }, "city" : { "type" : "string", "description" : "The city the order will be billed to." }, "state" : { "type" : "string", "description" : "The state the order will be billed to." }, "postalCode" : { "type" : "string", "description" : "The zip or postal code the order will be billed to." }, "countryCode" : { "type" : "string", "description" : "The two-character ISO country code the order will be billed to." }, "phoneNumber" : { "type" : "string", "description" : "The company contact phone number." }, "email" : { "type" : "string", "description" : "The company contact email address." } }, "additionalProperties" : false }, "SerialNumberB2B" : { "type" : "object", "properties" : { "serialNumber" : { "type" : "string", "description" : "The serial number for the line item." } }, "additionalProperties" : false }, "Servicecontractinfo" : { "type" : "object", "properties" : { "contractInfo" : { "$ref" : "#/components/schemas/Contractinfo" }, "subscriptions" : { "$ref" : "#/components/schemas/Subscriptions" }, "licenseInfo" : { "$ref" : "#/components/schemas/LicenseInfo" } }, "additionalProperties" : false }, "ShipmentDetailB2B" : { "type" : "object", "properties" : { "quantity" : { "type" : "integer", "format" : "int32", "description" : "The quantity shipped of the line item." }, "deliveryNumber" : { "type" : "string", "description" : "The actual date of delivery of the line item." }, "estimatedShipDate" : { "type" : "string", "default" : "", "description" : "The date the line item is expected to be shipped." }, "shipFromWarehouseId" : { "type" : "string", "description" : "The ID of the warehouse the product will ship from." }, "shipFromLocation" : { "type" : "string", "description" : "The city and state the line item ships from." }, "invoiceNumber" : { "type" : "string", "description" : "The Ingram Micro invoice number for the line item." }, "invoiceDate" : { "type" : "string", "default" : "", "description" : "The date the IngramMicro invoice was created for the line item." }, "carrierDetails" : { "type" : "array", "description" : "The shipment carrier details for the line item.", "items" : { "$ref" : "#/components/schemas/CarrierDetailB2B" }, "nullable" : true } }, "additionalProperties" : false }, "Subscriptions" : { "type" : "object", "properties" : { "subscriptionId" : { "type" : "string", "description" : "The ID of the subscription." }, "subscriptionTerm" : { "type" : "string", "description" : "The term of the subscription." }, "renewalTerm" : { "type" : "string", "description" : "The renewal term of the subscription." }, "billingModel" : { "type" : "string", "description" : "The billing model of the billing." }, "subcriptionStartDate" : { "type" : "string", "description" : "Start date of the subcription." }, "subcriptionEndDate" : { "type" : "string", "description" : "End date of the subcription." } }, "additionalProperties" : false }, "TrackingDetailB2B" : { "type" : "object", "properties" : { "trackingNumber" : { "type" : "string", "description" : "The tracking number for the shipment containing the line item." }, "trackingUrl" : { "type" : "string", "description" : "The tracking URL for the shipment containing the line item." }, "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." }, "quantityInBox" : { "type" : "string", "description" : "The quantity of line items in the box." }, "serialNumbers" : { "type" : "array", "description" : "A list of serial numbers of the line items contained in the shipment.", "items" : { "$ref" : "#/components/schemas/SerialNumberB2B" }, "nullable" : true } }, "additionalProperties" : false }, "order_create_v7_request": { "type": "object", "properties": { "quoteNumber": { "type": "string", "description": "A unique identifier generated by Ingram Micro's CRM specific to each quote.", "maxLength": 35 }, "customerOrderNumber": { "type": "string", "description": "The reseller's order number for reference in their system.", "maxLength": 18 }, "endCustomerOrderNumber": { "type": "string", "description": "The end customer's order number for reference in their system.", "maxLength": 18 }, "notes": { "type": "string", "description": "Order header level notes." }, "billToAddressId": { "type": "string", "description": "Suffix used to identify billing address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit." }, "specialBidNumber": { "type": "string", "description": "The bid number is provided to the reseller by the vendor for special pricing and discounts. Line-level bid numbers take precedence over header-level bid numbers." }, "acceptBackOrder": { "type": "boolean", "description": accept order if this item is backordered. This field along with shipComplete field decides the value of backorderflag. The value of this field is ignored when shipComplete field is present.", "enum" : [ "true", "false"] }, "vendAuthNumber": { "type": "string", "description": "Authorization number provided by vendor to Ingram's reseller. Orders will be placed on hold without this value, vendor specific mandatory field - please reach out Ingram Sales team for list of vendor for whom this is mandatory." }, "resellerInfo": { "type": "object", "description": "The address and contact information provided by the reseller.", "properties": { "resellerId": { "type": "string", "description": "The reseller's Id." }, "companyName": { "type": "string", "maxLength": 40, "description": "The reseller's company name." }, "contact": { "type": "string", "description": "The reseller's contact name." }, "addressLine1": { "type": "string", "description": "The reseller's address line 1" }, "addressLine2": { "type": "string", "description": "The reseller's address line 2." }, "city": { "type": "string", "description": "The reseller's city." }, "state": { "type": "string", "description": "The reseller's state." }, "postalCode": { "type": "string", "maxLength": 10, "description": "The reseller's zip or postal code." }, "countryCode": { "type": "string", "maxLength": 10, "description": "The reseller's two-character ISO country code." }, "phoneNumber": { "type": "integer", "description": "The reseller's phone number." }, "email": { "type": "string", "description": "The reseller's email address." } } }, "endUserInfo": { "type": "object", "description": "The contact information for the end user/customer provided by the reseller. Used to determine pricing and discounts", "properties": { "endUserId": { "type": "string", "description": "ID for the end user/customer in Ingram Micro's system." }, "contact": { "type": "string", "description": "The contact name for the end user/customer." }, "companyName": { "type": "string", "description": "The company name for the end user/customer. Required for Impulse countries.", "maxLength": 40 }, "addressLine1": { "type": "string", "description": "The end user/customer's street address and building or house number. Required for Impulse countries.", "maxLength": 70 }, "addressLine2": { "type": "string", "description": "The end user/customer's apartment number.", "maxLength": 70 }, "city": { "type": "string", "description": "The end user/customer's city. Required for Impulse countries.", "maxLength": 25 }, "state": { "type": "string", "description": "The end user/customer's state. Required for Impulse countries but optional for EMEA countries.", "maxLength": 3 }, "postalCode": { "type": "string", "description": "The end user/customer's zip or postal code. Required for Impulse countries.", "maxLength": 10 }, "countryCode": { "type": "string", "description": "The end user/customer's two-character ISO country code.", "maxLength": 10 }, "phoneNumber": { "type": "integer", "description": "The end user/customer's phone number." }, "email": { "type": "string", "description": "The end user/customer's email." } } }, "shipToInfo": { "type": "object", "description": "The shipping information provided by the reseller.", "properties": { "addressId": { "type": "string", "description": "The ID references the resellers address in Ingram Micro's system for shipping. Provided to resellers during the onboarding process.", "maxLength": 10 }, "contact": { "type": "string", "description": "The company contact provided by the reseller.", "maxLength": 70 }, "companyName": { "type": "string", "description": "The reseller's company name or the End-User's Name", "maxLength": 40 }, "addressLine1": { "type": "string", "description": "The street address and building or house number the order will be shipped to.", "maxLength": "70" }, "addressLine2": { "type": "string", "description": "The apartment number the order will be shipped to.", "maxLength": "70" }, "city": { "type": "string", "description": "The city the order will be shipped to.", "maxLength": 25 }, "state": { "type": "string", "description": "The state the order will be shipped to.", "maxLength": 3 }, "postalCode": { "type": "string", "description": "End User Name" }, "countryCode": { "type": "string", "description": "The zip or postal code the order will be shipped to.", "maxLength": 10 }, "email": { "type": "string", "description": "The company contact email address." }, "shippingNotes": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "The company contact phone number." } } }, "shipmentDetails": { "type": "object", "description": "Shipping details for the order provided by the customer.", "properties": { "carrierCode": { "type": "string", "description": "The code for the shipping carrier for the line item.", "maxLength": 2 }, "requestedDeliveryDate": { "type": "string", "description": "The reseller-requested delivery date in UTC format. Delivery date is not guaranteed. Must be a future date.", "maxLength": 8 }, "shipComplete": { "type": "string", "description": "Specifies whether the shipment will be shipped only when all products are fulfilled. The value of this field along with acceptBackOrder field decides the value of backorderflag. If this field is set, acceptBackOrder field is ignored. Possible values for this field are true, C, P, E.With value as true or C, backorderflag will be set as C.With value as P, or E, backorderflag will be set as P or E respectively.C = Ship complete at distribution level.P = ship complete at line level.E = ship complete across all distributions.", "maxLength": 1 }, "shippingInstructions": { "type": "string", "description": "Any special shipping instructions for the order.", "maxLength": 132 }, "freightAccountNumber": { "type": "string", "description": "The reseller 's shipping account number with carrier. Used to bill the shipping carrier directly from the reseller's account with the carrier." }, "signatureRequired": { "type": "boolean", "description": "Specifies whether a signature is required for delivery. Default is False." } } }, "additionalAttributes": { "type": "array", "description": "Shipment-level additional attributes.", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "**allowPartialOrder:** Allow orders with failed lines. \n\n\n**DpasRating:** DX rating by Department of Defense is the highest rating by the highest offices and meant to be top priority. DO any other gov offices at the federal level to priotize. \n\n **DpasProgramId:** Identifies the actual agency that signed off on the DPAS priority. \n\n **allowDuplicateCustomerOrderNumber:** Allow orders with duplicate customer PO numbers. Enables resellers to have the same PO number for multiple orders. \n \n **euDepId:** DEP ID would be the 'End User DEP/ABM Organization ID' up to 32 characters and is assigned by Apple.\n \n **depOrderNbr:** depOrderNbr is reseller’s own DEP ID assigned by Apple.\n \n **govtProgramType:** Program type, “PA” for government orders, “ED” for education order.\n \n **govtEndUserType:** Type of end user of the program. F = Federal, S = State, E = Local, K = K-12 school, and H = Higher Education\n \n **govtSolicitationNumber:** Education order’s contract number\n \n **govtPublicPrivateCode:** Determines TAX / NO TAX. 'P' PUBLIC SECTOR, 'R' PRIVATE SECTOR. Value needs only to be provided for EDUCATION order.\n \n **govtEndUserData:** Name of the End user of the program. For example, STATE OF OHIO, CHICAGO SCHOOLDISTRICT etc.\n \n **govtEndUserPostalCode:** 9 CHAR FIELD / Zip Code of the End user of the order.\n \n **dynamicMessageLine1:** Custom Dynamic Message line 1.\n \n **allowOrderOnCustomerHold:** Boolean value flag which allows a customer to create an order with the hold status." }, "attributeValue": { "type": "string", "description": "The attribute field data." } } } }, "vmfAdditionalAttributes": { "type": "array", "description": "The object containing the list of fields required at a header level by the vendor.
This a Deprecated object. Kindly use vmfVendorAdditionalAttributes object", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the header level field." }, "attributeValue": { "type": "string", "description": "The value of the header level field." } } } }, "vmfVendorAdditionalAttributes": { "type": "array", "description": "The object containing the list of Vendor Mandatory Fields required by the vendor for the Hardware products.", "items": { "type": "object", "properties": { "vendorName": { "type": "string", "description": "The name of the vendor" }, "productId": { "type": "string", "description": "The Product ID from the vendor" }, "additionalAttributes": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field" }, "attributeValue":{ "type": "string", "description": "The value of the vendor mandatory field" }, "attributeDescription":{ "type": "string", "description": "The description of the vendor mandatory field" }, "attributeHint":{ "type": "string", "description": "The hint of the vendor mandatory field." }, "choices": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributeValue": { "type": "string", "description": "The description of the vendor mandatory " }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory" }, "choices": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributename": { "type": "string", "description": "The name of the vendor mandatory field" }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field" } } } } } } } } } } } } }, "vriAdditionalAttributes": { "type": "array", "description": "The object containing the list of Vendor Mandatory Fields required by the vendor for the subscription products.
Use this object ONLY when using a full quote ordering for a subsciption product. For line-level ordering use vriAdditionalAttributes object inside the line object. ", "items": { "type": "object", "properties": { "vendorName": { "type": "string", "description": "The name of the vendor" }, "productId": { "type": "string", "description": "The Product ID from the vendor" }, "additionalAttributes": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field" }, "attributeValue":{ "type": "string", "description": "The value of the vendor mandatory field" }, "attributeDescription":{ "type": "string", "description": "The description of the vendor mandatory field" }, "attributeHint":{ "type": "string", "description": "The hint of the vendor mandatory field." }, "choices": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributeValue": { "type": "string", "description": "The description of the vendor mandatory " }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory" }, "choices": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributename": { "type": "string", "description": "The name of the vendor mandatory field" }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field" } } } } } } } } } } } } }, "lines": { "type": "array", "items": { "type": "object", "properties": { "customerLineNumber": { "type": "string", "description": "The reseller's line item number for reference in their system. The customer line number needs to be a unique numeric value between 1 and 884. In the event we receive duplicate values or alphanumeric values in the customer line number, we will re-sequence the customer line number. To prevent re-sequencing, please use a unique numeric value between 1 and 884 in the customer line number.", "maxLength": 3 }, "ingramPartNumber": { "type": "string", "description": "The unique IngramMicro part number.", "maxLength": 18 }, "vendorPartNumber": { "type": "string", "description": "The vendor's part number for the line item." }, "quantity": { "type": "integer", "description": "The requested quantity of the line item." }, "autolink": { "type": "boolean", "description": "Identifies and link the first compatible warranty available with the corresponding hardware SKU.", }, "unitPrice": { "type": "decimal", "description": "The reseller-requested unit price for the line item. The unit price is not guaranteed." }, "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 in the case of split orders or where different line items have different bid numbers. Line-level bid number take precedence over header-level bid numbers.", "maxLength": 36 }, "endUserPrice": { "type": "decimal", "description": "The end-user price. Required for Export Orders." }, "notes": { "type": "string", "description": "The attribute field data." }, "resourceId": { "type": "string", "description": "The resource id of the subscription" }, "planid": { "type": "string", "description": "ID of the subscription plan" }, "subscriptionPeriod": { "type": "object", "description": "The object containing the list of options related to the subscription period.", "properties": { "type": { "type": "string", "description": "Unit period of the subscription. Example, Years, Months" }, "duration": { "type": "integer", "description": "Length of the subscription. Example 1, 3" }, "startDate": { "type": "string", "description": "The date on which subscription will start." }, "endDateAlignmentType": { "type": "string", "description": "Subscription period end date alignment.", "enum" : [ "MATCH_END_OF_CALENDAR_MONTH", "CO_TERM_ON_SUBSCRIPTION"] }, "subscriptionId": { "type": "string", "description": "The ID of an existing active subscription." } } }, "billingPeriod": { "type": "object", "description": "The object containing the list of options related to the billing period.", "properties": { "type": { "type": "string", "description": "Billing period of the subscription. Example, Years, Months" }, "duration": { "type": "integer", "description": "Length of the billing period. Example 1, 3" } } }, "margin": { "type": "decimal", "description": "Line-level margin requested by customer" }, "endCustomerPrice": { "type": "decimal", "description": "Line-level end-customer price requsted by customer" }, "vriAdditionalAttributes": { "type": "array", "description": "The object containing the list of Vendor Mandatory Fields required by the vendor for the subscription products.", "items": { "type": "object", "properties": { "vendorName": { "type": "string", "description": "The name of the vendor" }, "productId": { "type": "string", "description": "The Product ID from the vendor" }, "additionalAttributes": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field" }, "attributeValue":{ "type": "string", "description": "The value of the vendor mandatory field" }, "attributeDescription":{ "type": "string", "description": "The description of the vendor mandatory field" }, "attributeHint":{ "type": "string", "description": "The hint of the vendor mandatory field." }, "choices": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributeValue": { "type": "string", "description": "The description of the vendor mandatory " }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory" }, "choices": { "type": "array", "description": "", "items": { "type": "object", "properties": { "attributename": { "type": "string", "description": "The name of the vendor mandatory field" }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field" } } } } } } } } } } } } }, "endUserInfo": { "type": "array", "items": { "type": "object", "properties": { "endUserId": { "type": "string", "description": "ID for the end user/customer in Ingram Micro's system.", "maxLength": 10 }, "endUserType": { "type": "string", "description": "Specifies the type of endUser. It can be endUser or endUserContact for SAP flow." }, "companyName": { "type": "string", "description": "The company name for the end user/customer." }, "addressLine1": { "type": "string", "description": "The end user/customer's street address and building or house number." }, "addressLine2": { "type": "string", "description": "The end user/customer's apartment number." }, "contact": { "type": "string", "description": "The contact name for the end user/customer." }, "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", "description": "The end user/customer's two-character ISO country code." }, "phoneNumber": { "type": "string", "description": "End User Name", "maxLength": 30 }, "email": { "type": "string", "description": "The end user/customer's email.", "maxLength": 241 } } } }, "additionalAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "SAP requested and country-specific line level details." }, "attributeValue": { "type": "string", "description": "TLine-level additional attributes." } } } }, "warrantyInfo": { "type": "array", "description": "", "items": { "type": "object", "properties": { "hardwareLineLink": { "type": "string", "description": "Customer line number of the warranty product in this request for linkage, either hardwareLineLink or warrantyLineLink can be used in a line" }, "warrantyLineLink": { "type": "string", "description": "Customer line number of the hardware product in this request for linkage, either hardwareLineLink or warrantyLineLink can be used in a line." }, "directLineLink": { "type": "string", "description": "Unique value to link hardware and warranty lines. Should be used only when products are purchased from both Ingram and/or vendor but the warranty is purchased through Ingram for them.", "maxLength": 25 }, "serialInfo": { "type": "array", "items": { "type": "object", "description": "Serial information of the hardware to be associated with the warranty, applicable on post sale orders.", "properties": { "dateOfPurchase": { "type": "string", "description": "Date of purchase of the hardware within vendor-defined grace period.", "maxLength": 8 }, "shipDate": { "type": "string", "description": "Vendor specific mandatory field, date of hardware/product shipment from vendor.", "maxLength": 8 }, "primarySerialNumber": { "type": "string", "description": "Serial number of the hardware/product." }, "secondarySerialNumber": { "type": "string", "description": "Serial number of accessory associated with the above hardware/product." } } } }, "historicalOrdersLinkage": { "type": "array", "items": { "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order purchased historically with Ingram." }, "orderDate": { "type": "string", "description": "Purchase date of the order within vendor-defined grace period", "maxLength": 8 }, "lines": { "type": "array", "items": { "type": "object", "properties": { "ingramPartNumber": { "type": "string", "description": "Ingram part number used in the original order." } } } } } } } } } } ,"vmfAdditionalAttributesLines": { "type": "array", "description": "The object containing the list of fields required at a line level by the vendor.
This a Deprecated object. Kindly use vmfVendorAdditionalAttributes object", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the line level field." }, "attributeValue": { "type": "string", "description": "The value of the line level field." } } } } } } } } }, "quote_create_request": { "type": "object", "properties": { "quoteName": { "type": "string", "description": "Quote Name given to quote by sales team or system generated. Generally used as a reference to identify the quote." }, "firstname": { "type": "string", "description": "Logged in Users firstname" }, "lastname": { "type": "string", "description": "Logged in Users Lastname" }, "CustomerContact": { "type": "string", "description": "Logged in Users email address contact.", "maxLength" : 64, "example" : "MyCompany", "required" : true }, "quoteExpiryDate": { "type": "string", "description": "The date on which a quote will expire." }, "customerNeed": { "type": "string", "description": "Any special need from the customer." }, "endUserInfo": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Name of the company associated with the quote." }, "contact": { "type": "string", "description": "Contact name of end user associated with the quote." }, "addressLine1": { "type": "string", "description": "Address line 1 for end user associated with the quote" },"addressLine2": { "type": "string", "description": "Address line 2 for end user associated with the quote" }, "city": { "type": "string", "description": "City for end user associated with the quote" }, "state": { "type": "string", "description": "Two letter state abbreviation for end user associated with the quote." }, "postalCode": { "type": "string", "description": "Zip code of end user associated with the quote." }, "countryCode": { "type": "string", "description": "Two letter Country abbreviation for end user associated with the quote." }, "email": { "type": "string", "description": "Email of end-user the quote associated with the quote." }, "phoneNumber": { "type": "string", "description": "Phone number of end user associated with the quote." } } }, "dealId": { "type": "string", "description": "Price discount identifyer to specify a pricing discount that has been applied to the quote." }, "pricingType":{ "type": "string", "description": "Pricing type of the quote." }, "sendQuoteCopy":{ "type": "string", "description": "List of email addressed to whom the quote will be emailed after it's created. (Max 10 email ids)" }, "products": { "type": "array", "items": { "type": "object", "properties" : { "customerLineNumber": { "type": "string", "description":"The reseller's line item number for reference in their system." }, "ingramPartNumber": { "type": "string", "description":"Ingram Micro SKU (stock keeping unit). An identification, usually alphanumeric, of a particular product that allows it to be tracked for inventory purposes" }, "vendorPartNumber": { "type": "string", "description":"Vendor Part Number" }, "quantity": { "type": "string", "description":"Quantity of product line item quoted." }, "specialBid": { "type": "string", "description":"Special bid associated with product line item" }, "lineLevelNotes": { "type": "string", "description":"Product line-item comments." }, "pricingType": { "type": "string", "description": "Pricing type of the quote" } } } } } }, "quote_create_webhook_response": { "type": "object", "properties": { "topic": { "type": "string", "description": "Field for identifying whether it is a reseller or vendor event. For eg, resellers/orders" }, "event": { "type": "string", "description": "The event sent in the request. For eg, im::create." }, "eventTimeStamp": { "type": "string", "description": "The timestamp at which the event was sent." }, "eventId": { "type": "string", "description": "A unique id used as identifier for the sepcific event and used for generating the x-hub signature." }, "resource": { "type": "object", "properties": { "eventType": { "type": "string", "description": "The event name sent in the event request." }, "quoteName": { "type": "string", "description": "Quote Name given to quote by sales team or system generated. Generally used as a reference to identify the quote." }, "quoteNumber": { "type": "string", "description": "Unique identifier generated by Ingram Micros CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes." }, "revision": { "type": "string", "description": "When a quote has been revised and updated, the quote number remains the same throughout the lifecycle of the quote, however, a Revision number is updated for each revision of the quote. The revision numbers is associated with the Unique Quote Number." }, "ingramQuoteDate": { "type": "date", "description" : "Date the Quote was initially Created." }, "lastModifiedDate": { "type": "date", "description" : "Date the Quote was last updated or modified." }, "ingramQuoteExpiryDate": { "type": "string", "description" : "Date when the Quote Expires." }, "specialBidExpirationDate": { "type": "date", "description" : "If a price discount has been applied to the quote - The date the discount expires and will no longer be applicable." }, "status": { "type": "date", "description" : "This refers to the primary status of the quote. API responses will return" }, "customerNeed": { "type": "string", "description" : "Details related to the customer's request for the quote entered by the sales representative or system generated." }, "proposedSolution": { "type": "string", "description" : "Ingram Micro proposed solution and summary of quote." }, "introPreamble": { "type": "string", "description" : "Introductory paragraph included in each quote. Legally required - must be included when presenting the quote details." }, "purchaseInstructions": { "type": "string", "description" : "Purchase instructions. Legally required - must be included when presenting the quote details." }, "legalTerms": { "type": "string", "description" : "Legal terms - Legally required - must be included when presenting the quote details." }, "resellerInfo": { "type": "object", "properties": { "contact": { "type": "string", "description" : "Contact Name" }, "companyName": { "type": "string", "description" : "Ingram Micro Customer's Account Name" }, "email": { "type": "string", "description" : "Account Contact Email Address" }, "phoneNumber": { "type": "string", "description" : "Account Phone Number" }, "customerNumber": { "type": "string", "description" : "Reseller account number" } } }, "endUserInfo": { "type": "object", "properties": { "contact": { "type": "string", "description" : "End User Name" }, "companyName": { "type": "string", "description" : "Contact name of end user associated with the quote." }, "addressLine1": { "type": "string", "description" : "Address line 1 for end user associated with the quote" }, "addressLine2": { "type": "string", "description" : "Address line 2 for end user associated with the quote." }, "addressLine3": { "type": "string", "description" : "Address line 3 for end user associated with the quote." }, "city": { "type": "string", "description" : "City for end user associated with the quote" }, "state": { "type": "string", "description" : "Two letter state abreviation for end user associated with the quote" }, "email": { "type": "string", "description" : "Email of end user the quote associated with the quote." }, "phoneNumber": { "type": "string", "description" : "Phone number of end user associated with the quote." }, "postalCode": { "type": "string", "description" : "Zip code of end user associated with the quote." }, "marketSegment": { "type": "string", "description" : "Market Segment of end user associated with the quote. End user market segment is included when end user is included in specific market segments like Educational, Government, Military, Medical - that may receive special pricing due to their segmentation." } } }, "products": { "type": "array", "items" : { "type" : "object", "properties" : { "quoteProductGuid" : { "type" : "string", "description" : "Quote Product GUID is the primary quote key in Ingram Micro's CRM - needed to retrieve quote details." }, "lineNumber" : { "type" : "string", "description" : "Line number which the product will appear in the quote. Line number is manditory when unique configurations are included in a quote and mainting the item line order is required." },"quantity" : { "type" : "string", "description" : "Quantity of product line item quoted." }, "notes" : { "type" : "string", "description" : "Product line item comments." }, "ean" : { "type" : "string", "description" : "EANUPC" }, "coo" : { "type" : "string", "description" : "Country of Origin." }, "ingramPartNumber" : { "type" : "string", "description" : "Ingram Micro SKU (stock keeping unit). An identification, usually alphanumeric, of a particular product that allows it to be tracked for inventory purposes" }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor Part Number" }, "description" : { "type" : "string", "description" : "Product description. Note - The quote view api returns only the product short description as maintained in Ingram Micro's crm system. For long descriptions, please refer to alternative information sources." }, "weight" : { "type" : "string", "description" : "Weight is provided based on country standard. For countries following Imperial standards - weight is presented as pounds with decimal. In countries following metric standards, weight is provided as kilograms with decimal." }, "weightUom" : { "type" : "string", "description" : "Unit of measure" }, "isSuggestionProduct" : { "type" : "string", "description" : "Flag to indicate if a product line item is a suggested product. The suggested product is provided in addition to the requested quoted products and a suggested option. Suggested products are grouped together for subtotal and total calculations." }, "vpnCategory" : { "type" : "string", "description" : "Vendor product category specific to Cisco. HWDW (hardware) or service." }, "quoteProductsSupplierPartAuxiliaryId" : { "type" : "string", "description" : "Vendor product configuration ID specific to Cisco." }, "vendorName" : { "type" : "string", "description" : "Vendor name of the product" }, "terms" : { "type" : "string", "description" : "Terms of the quote" }, "price" : { "type" : "object", "description" : "", "properties" : { "quotePrice" : { "type" : "integer", "description" : "Ingram Micro quoted price specific to the reseller and quote." }, "msrp" : { "type" : "integer", "description" : "Manufacturer Suggested Retail Price" }, "extendedMsrp" : { "type" : "integer", "description" : "Extended MSRP - Manufacturer Suggested Retail Price X Quantity" }, "extendedQuotePrice" : { "type" : "integer", "description" : "Extended reseller quoted price (cost to reseller) X Quantity" }, "discountOffList" : { "type" : "number", "format":"decimal", "description" : "Discount off list percentage" } } } } } }, "productsCount" : { "type" : "integer", "description" : "Total number of products included in the quote" }, "extendedMsrpTotal" : { "type" : "integer", "description" : "Total extended MSRP for all products included in the quote" }, "quantityTotal" : { "type" : "integer", "description" : "Total quantity of all items in the quote." }, "extendedQuotePriceTotal" : { "type" : "integer", "description" : "Total amount of quoted price for all products in the quote including both solution products and suggested products." }, "additionalAttributes": { "type": "array", "items" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "**estimateId -** is the identification number for an estimate provided by Cisco for a quote.\n\n**dealId -** is the identification number for the specific deal pricing related to a Cisco quote\n\n**vendorName -** Name of Vendor associated with the quote.\n\n**vendorMessage -** Vendor Message is associated with primary vendor in the quote. In cases where a vendor requires a message be presented in the quote, the vendor name and message will be retreived and must be included in the quote vendor message fields." }, "attributeValue" : { "type" : "string", "description":"The attribute field data." } } } } } } } }, "quote_create_response": { "type": "object", "properties": { "quoteNumber": { "type": "string", "description": "A unique identifier generated by Ingram Micro's CRM specific to each quote." }, "message": { "type": "string", "description": "A confirmation message." } } }, "OrderCreateV7Response201": { "type": "object", "properties": { "quoteNumber": { "type": "string", "description": "A unique identifier generated by Ingram Micro's CRM specific to each quote." }, "confirmationNumber": { "type": "number", "example": 987654322, "description": "A unique confirmation number for tracking purposes." }, "message": { "type": "string", "description": "A confirmation message." } } }, "OrderCreateV7Response": { "type": "object", "properties": { "topic": { "type": "string", "description": "Field for identifying whether it is a reseller or vendor event. For eg, resellers/orders" }, "event": { "type": "string", "description": "The event sent in the request. For eg, im::create." }, "eventTimeStamp": { "type": "string", "description": "The timestamp at which the event was sent." }, "eventId": { "type": "string", "description": "A unique id used as identifier for the sepcific event and used for generating the x-hub signature." }, "eventType": { "type": "string", "description": "The event name sent in the event request." }, "resource": { "type": "object", "properties": { "customerOrderNumber": { "type": "string", "description": "The reseller's unique PO/Order number." }, "billToAddressId": { "type": "string", "description": "Suffix used to identify billing address. Created during onboarding. Resellers are provided with one or more address IDs depending on how many bill to addresses they need for various flooring companies they are using for credit" }, "orderSplit": { "type": "boolean", "description": "true for multiple orders" }, "processedPartially": { "type": "boolean", "description": "true for partial order succesfully placed" }, "purchaseOrderTotal": { "type": "number", "format": "decimal", "description": "Total of all the orders including taxes and fees." }, "shipToInfo": { "type": "object", "description": "The shipping information provided by the reseller.", "properties": { "addressId": { "type": "string", "description": "The ID references the resellers address in Ingram Micro's system for shipping. Provided to resellers during the onboarding process." }, "companyName": { "type": "string", "description": "The reseller's company name or the End-User's Name" }, "addressLine1": { "type": "string", "description": "The street address and building or house number the order will be shipped to." }, "addressLine2": { "type": "string", "description": "The apartment number the order will be shipped to." }, "city": { "type": "string", "description": "The city the order will be shipped to." }, "state": { "type": "string", "description": "The state the order will be shipped to." }, "postalCode": { "type": "string", "description": "The zip or postal code the order will be shipped to." }, "countryCode": { "type": "string", "description": "The two-character ISO country code the order will be shipped to." } } }, "orders": { "type": "array", "description": "Order-level details.", "items": { "type": "object", "properties": { "numberOfLinesWithSuccess": { "type": "integer", "description": "The number of lines in the order that were successful." }, "numberOfLinesWithError": { "type": "integer", "description": "The number of lines in the order that have errors." }, "numberOfLinesWithWarning": { "type": "integer", "description": "The number of lines in the order that have a warning." }, "ingramOrderNumber": { "type": "string", "description": "The Ingram Micro order number." }, "ingramOrderDate": { "type": "string", "description": "The date in UTC format that the order was created in Ingram Micro's system." }, "notes": { "type": "string", "description": "Order-level notes." }, "orderType": { "type": "string", "description": "The order typer. One of: S=Stocked PO D=Direct Ship PO" }, "orderTotal": { "type": "number", "format": "decimal", "description": "The total price for the order." }, "freightCharges": { "type": "number", "format": "decimal", "description": "The total freight charges for the order." }, "totalTax": { "type": "number", "format": "decimal", "description": "The total tax for the order." }, "currencyCode": { "type": "string", "description": "The country-specific three character ISO 4217 currency code used for the order." }, "lines": { "type": "array", "description": "The line-level details for the order.", "items": { "type": "object", "properties": { "subOrderNumber": { "type": "string", "description": "The sub order number. The two-digit prefix is the warehouse code of the warehouse nearest the reseller. The middle number is the order number. The two-digit suffix is the sub order number." }, "ingramLineNumber": { "type": "string", "description": "The Ingram Micro line number for the product." }, "customerLineNumber": { "type": "string", "description": "The reseller's line number for reference in their system." }, "lineStatus": { "type": "string", "description": "The status for the line item in the order. One of: Backordered, Open" }, "ingramPartNumber": { "type": "string", "maxLength": 6, "description": "The Ingram Micro part number for the line item." }, "unitPrice": { "type": "number", "format": "decimal", "description": "The unit price for the line item." }, "extendedUnitPrice": { "type": "number", "format": "decimal", "description": "The extended list price (unit price X quantity) for the line item." }, "quantityOrdered": { "type": "integer", "description": "The quantity of the line item ordered." }, "quantityConfirmed": { "type": "integer", "description": "The quantity of the line item that has been confirmed." }, "quantityBackOrdered": { "type": "integer", "description": "The quantity of the line item that is backordered." }, "notes": { "type": "string", "description": "Line-level notes." }, "shipmentDetails": { "type": "array", "description": "The shipment details for the line item.", "items": { "type": "object", "properties": { "carrierCode": { "type": "string", "description": "The code for the shipping carrier for the line item." }, "carrierName": { "type": "string", "description": "The name of the shipping carrier for the line item." }, "shipFromWarehouseId": { "type": "string", "description": "The ID of the warehouse the line item will ship from." }, "shipFromLocation": { "type": "string", "description": "Location from which order is shipped." } } } } } }, "links": { "type": "array", "description": "Link to Order Details for the order(s).", "items": { "type": "object", "properties": { "topic": { "type": "string", "description": "Provides the details of the orders." }, "href": { "type": "string", "description": "The URL endpoint for accessing the relevant data." }, "type": { "type": "string", "description": "The type of call that can be made to the href link (GET, POST, Etc.)." } } } } } } } } } } } }, "VendorRequiredInfoRequest": { "type" : "object", "properties" : { "quoteNumber": { "type": "string", "description": "A unique identifier generated by Ingram Micro's CRM specific to each quote.", "example": "QUO-14551943-D2Y9L9" }, "products" : { "type" : "array", "items" : { "properties" : { "ingramPartNumber" : { "type" : "string", "description" : "Ingram Micro unique part number for the product." }, "vendorPartNumber" : { "type" : "string", "description" : "Vendor’s part number for the product. It can be either TS Product or Cloud Product vendorpartnumber." }, "planID" : { "type" : "integer", "description" : "The ID of the subscription plan." } } } } } }, "VendorRequiredInforesponse": { "type": "array", "items": { "type": "object", "properties": { "quoteNumber": { "type": "string", "description": "A unique identifier generated by Ingram Micro's CRM specific to each quote.", "example": "quoteNumber=QUO-14551943-D2Y9L9" }, "ingramPartNumber": { "type": "string", "maxLength": 18, "description": "The unique IngramMicro part number." }, "vendorPartNumber": { "type": "string", "description": "The vendor's part number for the line item." }, "planId": { "type": "string", "description": "ID of the subscription plan" }, "planName": { "type": "string", "description": "Name of the subscription plan" }, "responseMessages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID to identify the error." }, "traceId": { "type": "string", "description": "A unique trace id to identify the issue." }, "type": { "type": "string", "description": "Type of the error message." }, "message": { "type": "string", "description": "A detailed error message." } } } }, "vmfAdditionalAttributes": { "type": "array", "items": { "type": "object", "properties": { "vendorName": { "type": "string", "description": "The name of vendor." }, "productId": { "type": "string", "description": "The ID of product." }, "additionalAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field." }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field." }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory field." }, "attributeHint": { "type": "string", "description": "The hint of the vendor mandatory field." }, "choices": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field." }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field." }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory field." }, "attributeHint": { "type": "string", "description": "The hint of the vendor mandatory field." }, "attributeRequired": { "type": "string", "description": "The required of the vendor mandatory field." }, "choices": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field." }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field." }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory field." }, "attributeHint": { "type": "string", "description": "The hint of the vendor mandatory field." }, "attributeRequired": { "type": "string", "description": "The required of the vendor mandatory field." } } } } } } } } } } } } }, "vriAdditionalAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field." }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field." }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory field." }, "attributeHint": { "type": "string", "description": "The hint of the vendor mandatory field." }, "choices": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field." }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field." }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory field." }, "attributeHint": { "type": "string", "description": "The hint of the vendor mandatory field." }, "attributeRequired": { "type": "string", "description": "The required of the vendor mandatory field." }, "choices": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "The name of the vendor mandatory field." }, "attributeValue": { "type": "string", "description": "The value of the vendor mandatory field." }, "attributeDescription": { "type": "string", "description": "The description of the vendor mandatory field." }, "attributeHint": { "type": "string", "description": "The hint of the vendor mandatory field." }, "attributeRequired": { "type": "string", "description": "The required of the vendor mandatory field." } } } } } } } } } } } } }, "subscrption_list_response":{ "type": "object", "properties": { "recordsFound": { "type": "integer", "description": "Total number of records matching the query" }, "pageSize": { "type": "integer", "description": "Number of records per page (default: 5)" }, "pageNumber": { "type": "integer", "description": "Current page number (default: 1)" }, "subscriptionsSummary": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total subscriptions matching the query" }, "active": { "type": "integer", "description": "Number of active subscriptions" }, "pending": { "type": "integer", "description": "Number of pending subscriptions" }, "trial": { "type": "integer", "description": "Number of trial subscriptions" }, "expiringWithin7Days": { "type": "integer", "description": "Subscriptions expiring within the next 7 days" }, "expiringWithin30Days": { "type": "integer", "description": "Subscriptions expiring within the next 30 days" }, "autoRenewWithin30Days": { "type": "integer", "description": "Subscriptions set to auto-renew within the next 30 days" } } }, "subscriptions": { "type": "array", "description": "List of subscription objects matching the search criteria", "items": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "Unique identifier for the subscription" }, "planName": { "type": "string", "description": "Subscription plan name" }, "customerOrderNumber": { "type": "string", "description": "Customer's order reference number" }, "endCustomer": { "type": "string", "description": "Name of the end customer" }, "endCustomerId": { "type": "string", "description": "Unique identifier for the end customer" }, "isAutoRenew": { "type": "boolean", "description": "Indicates whether the subscription renews automatically" }, "isTrial": { "type": "boolean", "description": "Indicates whether this is a trial subscription" }, "subscriptionPeriod": { "type": "integer", "description": "Duration of the subscription period. (Commitment period - Numeric value)" }, "subscriptionPeriodUnit": { "type": "string", "description": "Indicates the time unit of the subscription period. (MONTHS, YEARS)" }, "billingPeriod": { "type": "integer", "description": "Indicates the billing cycle. (Numeric value)" }, "billingPeriodUnit": { "type": "string", "description": "Indicates the time unit of the billing period. (MONTHS, YEARS)" }, "subscriptionStartDate": { "type": "string", "format": "date-time", "description": "Subscription start date" }, "subscriptionEndDate": { "type": "string", "format": "date-time", "description": "Subscription end date" }, "quantity": { "type": "integer", "description": "Number of units included in the subscription (Licenses, Users, seats, etc.)" }, "unitOfMeasure": { "type": "string", "description": "Unit of measure for the subscription (e.g., seats, licenses)" }, "status": { "type": "string", "description": "Current subscription status (e.g., ACTIVE, EXPIRED, CANCELLED)" }, "links": { "type": "object", "properties": { "topic": { "type": "string", "description": "Provides details of the Subscription" }, "href": { "type": "string", "description": "The URL endpoint for accessing the relevant data" }, "type": { "type": "string", "enum": ["GET"], "description": "The type of call that can be made to the href link" } } } } } }, "nextPage": { "type": "string", "description": "Link/URL for accessing next page (if available)" }, "previousPage": { "type": "string", "description": "Link/URL for accessing the previous page (if available)" } } }, "subscrption_details_response":{ "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "Unique identifier for the subscription" }, "planId": { "type": "string", "description": "Unique identifier for the subscription plan" }, "planName": { "type": "string", "description": "Name of the subscription plan" }, "status": { "type": "string", "description": "Current subscription status (e.g., ACTIVE, EXPIRED)" }, "isAutoRenew": { "type": "boolean", "description": "Indicates whether the subscription renews automatically" }, "customerOrderNumber": { "type": "string", "description": "Customer's order reference number" }, "endCustomerName": { "type": "string", "description": "Name of the end customer" }, "subscriptionPeriod": { "type": "integer", "description": "Duration of the subscription period. (Commitment period - Numeric value)" }, "subscriptionPeriodUnit": { "type": "string", "description": "Indicates the time unit of the subscription period. (MONTHS, YEARS)" }, "billingPeriod": { "type": "integer", "description": "Indicates the billing cycle. (Numeric value)" }, "billingPeriodUnit": { "type": "string", "description": "Indicates the time unit of the billing period. (MONTHS, YEARS)" }, "startDate": { "type": "string (date)", "description": "Subscription start date" }, "endDate": { "type": "string (date)", "description": "Subscription end date" }, "nextBillingDate": { "type": "string (date)", "description": "Next billing date for the subscription" }, "lastDayForChanges": { "type": "string (date)", "description": "Last date to modify the subscription before renewal lock period begins" }, "allowedOperations": { "type": "object", "description": "List of operations currently permitted on this subscription in its current state. (If includeOperations=true as a Query Parameter)", "properties": { "changeAllowed": { "type": "boolean", "description": "Indicates whether subscription modifications are permitted, including quantity adjustments, upsizing, downsizing, or plan switching. Call the Plan API for detailed change options." }, "partialUpgrade": { "type": "boolean", "description": "Indicates whether partial upgrade is allowed for this subscription" }, "CoTerm": { "type": "boolean", "description": "Indicates whether co-terming (aligning subscription end dates) is available for this subscription" }, "changeAutoRenew": { "type": "boolean", "description": "Indicates whether auto-renewal can be turned ON/OFF for this subscription in its current state" }, "putOnHold": { "type": "boolean", "description": "Indicates whether the subscription can be placed on hold" }, "cancel": { "type": "boolean", "description": "Indicates whether the subscription can be cancelled" } } }, "paymentTermsCode": { "type": "string", "description": "Payment terms identifier" }, "revenueMetrics": { "type": "object", "description": "Financial metrics for the subscription", "properties": { "profit": { "type": "number", "description": "Total profit from subscription" }, "revenuePerYear": { "type": "number", "description": "Annual revenue from subscription" }, "margin": { "type": "number", "description": "Profit margin percentage" }, "costPerYear": { "type": "number", "description": "Annual cost of subscription" }, "currencyCode": { "type": "string", "description": "Currency code (e.g., USD, EUR)" } } }, "resources": { "type": "array", "description": "List of resources included in the subscription", "items": { "resourceName": { "type": "string", "description": "Name of the resource/product" }, "vendorPartNumber": { "type": "string", "description": "Vendor's part number identifier" }, "quantity": { "type": "number", "description": "Number of units included in the subscription (Licenses, Users, seats, etc..)" }, "unitOfMeasure": { "type": "string", "description": "Unit of measure for the subscription (e.g., seats, licenses)" }, "unitCost": { "type": "number", "description": "Cost per unit (Customer)" }, "unitPrice": { "type": "number", "description": "Price per unit (End Customer)" }, "margin": { "type": "number", "description": "Margin percentage for this resource" }, "currencyCode": { "type": "string", "description": "Currency code (e.g., USD, EUR)" } } }, "subscriptionsHistory": { "type": "array", "description": "Historical order records for this subscription", "items": { "createdOn": { "type": "string (date)", "description": "Date the order was created" }, "status": { "type": "string", "description": "Order status (e.g., Completed)" }, "orderType": { "type": "string", "description": "Type of order (Sales, Billing, Renewal, Change)" }, "ingramOrderNumber": { "type": "string", "description": "Ingram Micro order number" }, "orderId": { "type": "string", "description": "Internal order identifier" }, "orderTotal": { "type": "number", "description": "Total amount for the order" }, "currencyCode": { "type": "string", "description": "Currency code for order total" } } }, "endCustomerDetails": { "type": "object", "description": "End customer information", "properties": { "companyName": { "type": "string", "description": "End customer company name" }, "accountID": { "type": "string", "description": "End customer account identifier" }, "resellerAccountId": { "type": "string", "description": "Reseller account identifier" }, "administrativeContact": { "type": "object", "description": "Administrative contact details", "properties": { "contactPerson": { "type": "string", "description": "Contact person" }, "email": { "type": "string", "description": "Email" }, "phone": { "type": "string", "description": "Phone" } } }, "billingContact": { "type": "object", "description": "Billing contact details", "properties": { "contactPerson": { "type": "string", "description": "Contact person" }, "email": { "type": "string", "description": "Email" }, "phone": { "type": "string", "description": "Phone" } } }, "technicalContact": { "type": "object", "description": "Technical contact details", "properties": { "contactPerson": { "type": "string", "description": "Contact person" }, "email": { "type": "string", "description": "Email" }, "phone": { "type": "string", "description": "Phone" } } } } } } }, "plan_details_api_response":{ "type": "object", "properties": { "currentSubscription": { "type": "object", "description": "Details of the current subscription plan", "properties": { "planId": { "type": "string", "description": "Unique identifier for the current plan" }, "planName": { "type": "string", "description": "Display name of the current plan" }, "description": { "type": "string", "description": "Detailed description of plan features and capabilities" }, "billingPeriod": { "type": "object", "description": "Billing frequency configuration", "properties": { "unit": { "type": "string", "description": "Time unit (MONTHS, YEARS)" }, "period": { "type": "string", "description": "Numeric value for the billing period" } } }, "subscriptionPeriod": { "type": "array", "description": "Available subscription term options", "items": { "type": "object", "properties": { "unit": { "type": "string", "description": "Time unit (MONTHS, YEARS)" }, "period": { "type": "string", "description": "Numeric value for the subscription period" }, "policy": { "type": "object", "description": "Change permissions for this term", "properties": { "immediateSwitchAllowed": { "type": "boolean", "description": "If immediate plan switching is permitted" }, "downSizeAllowed": { "type": "boolean", "description": "If quantity reduction is permitted" }, "upsizeAllowed": { "type": "boolean", "description": "If quantity increase is permitted" } } } } } }, "resources": { "type": "array", "description": "Resources included in the current plan", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "Unique identifier for the resource" }, "resourceUId": { "type": "string", "description": "Universal unique identifier (UUID)" }, "resourceName": { "type": "string", "description": "Resource provider name" }, "vendorPartNumber": { "type": "string", "description": "Vendor's part number" }, "minUnits": { "type": "integer", "description": "Minimum quantity allowed" }, "maxUnits": { "type": "integer", "description": "Maximum quantity allowed" }, "unitOfMeasure": { "type": "string", "description": "Unit type (Licenses, Users, Seats)" } } } } } }, "upgrade": { "type": "array", "description": "Plans available for full subscription upgrade", "items": { "type": "object", "properties": { "planId": { "type": "string", "description": "Unique identifier for the upgrade plan" }, "planName": { "type": "string", "description": "Display name of the upgrade plan" }, "description": { "type": "string", "description": "Detailed description of upgrade plan features" }, "billingPeriod": { "type": "object", "description": "Billing frequency for upgrade plan", "properties": { "unit": { "type": "string", "description": "Time unit (MONTHS, YEARS)" }, "period": { "type": "string", "description": "Numeric billing period value" } } }, "subscriptionPeriod": { "type": "array", "description": "Term options for upgrade plan", "items": { "type": "object", "properties": { "unit": { "type": "string", "description": "Term unit value" }, "period": { "type": "string", "description": "Term period type" }, "policy": { "type": "object", "description": "Permissions for upgrade plan term", "properties": { "immediateSwitchAllowed": { "type": "boolean", "description": "If immediate switching is allowed" }, "downSizeAllowed": { "type": "boolean", "description": "If downsizing is allowed" }, "upsizeAllowed": { "type": "boolean", "description": "If upsizing is allowed" } } } } } }, "resources": { "type": "array", "description": "Resources in the upgrade plan", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "Unique identifier for resource" }, "resourceUId": { "type": "string", "description": "Universal unique identifier" }, "resourceName": { "type": "string", "description": "Resource provider name" }, "vendorPartNumber": { "type": "string", "description": "Vendor's part number" }, "minUnits": { "type": "integer", "description": "Minimum allowed quantity" }, "maxUnits": { "type": "integer", "description": "Maximum allowed quantity" }, "unitOfMeasure": { "type": "string", "description": "Unit type for measurement" }, "resourceMapping": { "type": "object", "description": "Source to target resource transition", "properties": { "fromResourceId": { "type": "string", "description": "Current resource identifier" }, "targetResourceId": { "type": "string", "description": "Target resource identifier after upgrade" } } } } } } } } }, "partialUpgrade": { "type": "array", "description": "Plans for partial subscription upgrade", "items": { "type": "object", "properties": { "planId": { "type": "string", "description": "Unique identifier for partial upgrade plan" }, "planName": { "type": "string", "description": "Display name of partial upgrade plan" }, "description": { "type": "string", "description": "Description of partial upgrade features" }, "billingPeriod": { "type": "object", "description": "Billing frequency configuration", "properties": { "unit": { "type": "string", "description": "Time unit for billing" }, "period": { "type": "string", "description": "Billing period value" } } }, "subscriptionPeriod": { "type": "array", "description": "Available term options", "items": { "type": "object", "properties": { "unit": { "type": "string", "description": "Term unit" }, "period": { "type": "string", "description": "Term period" }, "policy": { "type": "object", "description": "Change permissions", "properties": { "immediateSwitchAllowed": { "type": "boolean", "description": "Immediate switching permission" }, "downSizeAllowed": { "type": "boolean", "description": "Downsizing permission" }, "upsizeAllowed": { "type": "boolean", "description": "Upsizing permission" } } } } } }, "resources": { "type": "array", "description": "Resources in partial upgrade", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "Resource identifier" }, "resourceUId": { "type": "string", "description": "Universal unique identifier" }, "vendorPartNumber": { "type": "string", "description": "Vendor part number" }, "minUnits": { "type": "integer", "description": "Minimum quantity" }, "maxUnits": { "type": "integer", "description": "Maximum quantity" }, "unitOfMeasure": { "type": "string", "description": "Unit of measure" } } } } } } }, "cotermOptions": { "type": "object", "description": "Co-term alignment configuration options", "properties": { "alignmentTypes": { "type": "array", "description": "Available alignment methods", "items": { "type": "string", "enum": [ "SAME_AS_PREVIOUS", "MATCH_END_OF_CALENDAR_MONTH", "CO_TERM_ON_SUBSCRIPTION" ] } }, "cotermSubscriptions": { "type": "array", "description": "Subscriptions available for co-terming", "items": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "Id of the subscription to co-term with" }, "name": { "type": "string", "description": "Name of the subscription to co-term with" }, "expirationDate": { "type": "string", "format": "date", "description": "Expiration date of the subscription to co-term with" } } } } } } } }, "estimate_plan_response":{ "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "Unique identifier of the subscription being estimated" }, "planId": { "type": "string", "description": "Plan identifier for the estimated configuration" }, "planName": { "type": "string", "description": "Display name of the plan" }, "summary": { "type": "object", "description": "Financial summary totals for the estimate", "properties": { "isDualCurrency": { "type": "boolean", "description": "Indicates if dual currency pricing is enabled" }, "customerCurrency": { "type": "string", "description": "Currency code for customer pricing (e.g., MXN, USD)" }, "vendorCurrency": { "type": "string", "description": "Currency code for vendor pricing (only if isDualCurrency=true)" }, "customer": { "type": "object", "description": "Reseller/customer cost summary", "properties": { "taxAmount": { "type": "number", "description": "Total tax amount in customer currency" }, "discount": { "type": "number", "description": "Total discount amount in customer currency" }, "totalCost": { "type": "number", "description": "Total cost to reseller in customer currency" }, "taxAmountVendorCurrency": { "type": "number", "description": "Tax in vendor currency (only if isDualCurrency=true)" }, "totalCostVendorCurrency": { "type": "number", "description": "Total cost in vendor currency (only if isDualCurrency=true)" } } }, "endCustomer": { "type": "object", "description": "End customer price summary", "properties": { "taxAmount": { "type": "number", "description": "Total tax amount for end customer" }, "discount": { "type": "number", "description": "Total discount amount for end customer" }, "totalPrice": { "type": "number", "description": "Total price to end customer" }, "taxAmountVendorCurrency": { "type": "number", "description": "Tax in vendor currency (only if isDualCurrency=true)" }, "totalPriceVendorCurrency": { "type": "number", "description": "Total price in vendor currency (only if isDualCurrency=true)" } } } } }, "resources": { "type": "array", "description": "Detailed pricing breakdown by resource", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "Unique identifier for the resource" }, "resourceName": { "type": "string", "description": "Display name of the resource" }, "vendorPartNumber": { "type": "string", "description": "Vendor's part number for the resource" }, "quantity": { "type": "number", "description": "Number of units in the estimate" }, "unitOfMeasure": { "type": "string", "description": "Unit type (Licenses, Users, Seats)" }, "pricing": { "type": "object", "description": "Price details for this resource", "properties": { "customer": { "type": "object", "description": "Reseller cost for this resource", "properties": { "unitCost": { "type": "number", "description": "Cost per unit to reseller" }, "setupCost": { "type": "number", "description": "One-time setup cost (if applicable)" }, "discount": { "type": "number", "description": "Discount applied to this resource" }, "taxAmount": { "type": "number", "description": "Tax for this resource" }, "totalCost": { "type": "number", "description": "Total cost for this resource" }, "taxAmountVendorCurrency": { "type": "number", "description": "Tax in vendor currency (only if isDualCurrency=true)" }, "totalCostVendorCurrency": { "type": "number", "description": "Total in vendor currency (only if isDualCurrency=true)" } } }, "endCustomer": { "type": "object", "description": "End customer price for this resource", "properties": { "unitPrice": { "type": "number", "description": "Price per unit to end customer" }, "setupPrice": { "type": "number", "description": "One-time setup price (if applicable)" }, "discount": { "type": "number", "description": "Discount applied" }, "taxAmount": { "type": "number", "description": "Tax for this resource" }, "totalPrice": { "type": "number", "description": "Total price for this resource" }, "taxAmountVendorCurrency": { "type": "number", "description": "Tax in vendor currency (only if isDualCurrency=true)" }, "totalPriceVendorCurrency": { "type": "number", "description": "Total in vendor currency (only if isDualCurrency=true)" } } } } } } } } } }, "subscription_change_request":{ "type": "object", "required": [ "subscriptionId", "orderType", "subscriptionPeriod", "planId", "resources" ], "properties": { "subscriptionId": { "type": "integer", "description": "Unique identifier of the subscription to be modified. Obtained from the Subscription List or Subscription Details API." }, "orderType": { "type": "string", "description": "Specifies the type of order operation.", "enum": [ "CHANGE", "PARTIALUPGRADE", "COTERM", "CANCEL" ] }, "subscriptionPeriod": { "type": "object", "description": "Subscription commitment term. For CHANGE operations, reflects the current period. For Upgrades, must reflect the destination plan period.", "required": [ "type", "duration" ], "properties": { "type": { "type": "string", "description": "Unit of the subscription period.", "enum": [ "YEARS", "MONTHS" ] }, "duration": { "type": "integer", "description": "Numeric duration of the subscription period (e.g., 1)." } } }, "planId": { "type": "integer", "description": "Plan identifier. For Upsize and Co-term: current plan ID. For Upgrade and Partial Upgrade: destination plan ID." }, "agreedtoupgrade": { "type": "boolean", "description": "Indicates acceptance of upgrade terms. Required for some vendor-specific upgrade operations." }, "resources": { "type": "array", "description": "Array of resource objects defining the quantities and resource IDs to be modified.", "items": { "type": "object", "required": [ "resourceId", "quantity" ], "properties": { "resourceId": { "type": "string", "description": "The resource ID of the subscription resource to be modified." }, "quantity": { "type": "integer", "description": "Upsize: final total quantity. Upgrade: total quantity of current subscription. Partial Upgrade: quantity to move. Co-term: current total quantity." }, "targetResourceId": { "type": "integer", "description": "Required for Upgrade and Partial Upgrade. Target resource ID in the destination plan." }, "endCustomerPrice": { "type": "number", "description": "Overrides the end-customer unit price for this resource. Applicable to Upsize and Upgrade operations." }, "margin": { "type": "number", "description": "Adjusts end-customer price based on desired reseller margin percentage. Cannot be combined with endCustomerPrice." } } } }, "changeSubscriptionsinfo": { "type": "object", "description": "Required for COTERM operations. Contains co-term configuration details.", "properties": { "expiryStatus": { "type": "string", "description": "Defines how the subscription end date is aligned.", "enum": [ "MATCH_END_OF_CALENDAR_MONTH", "CO_TERM_ON_SUBSCRIPTION" ] }, "cotermSubscriptionId": { "type": "integer", "description": "Required when expiryStatus is CO_TERM_ON_SUBSCRIPTION. Subscription ID whose end date will be matched." } } }, "vriAdditionalAttributes": { "type": "array", "description": "Vendor-Required Information (VRI) attributes. Required only for some vendors.", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "Name of the vendor-required attribute (e.g., tenant_preference, microsoft_domain, mca_acceptance)." }, "attributeValue": { "type": "string", "description": "Value of the vendor-required attribute. Must match allowed choices if provided." } } } }, "additionalAttributes": { "type": "array", "description": "Optional key-value pairs for supplementary order information.", "items": { "type": "object", "properties": { "attributeName": { "type": "string", "description": "Additional attribute name (e.g., PONumber)." }, "attributeValue": { "type": "string", "description": "Value of the additional attribute (e.g., MYPO-2026-001)." } } } } } }, "subscription_change_response":{ "type": "object", "properties": { "confirmationNumber": { "type": "string", "description": "Unique identifier for the submitted order change request. Used to match the asynchronous webhook callback. This value must be stored immediately upon receipt and matched with the async response received via webhook." }, "message": { "type": "string", "description": "Human-readable status message confirming the request has been received and is being processed." } } } }, "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" : "" } } } }