Skip to content

Commit

Permalink
Merge pull request #81 from ingrammicro-xvantage/feature/tweak-workflow
Browse files Browse the repository at this point in the history 
 v7 order create nullable fields
  • Loading branch information
@im-deviprakash
im-deviprakash authored Jan 7, 2025
2 parents 050e347 + f8b986e commit c3b326f
Showing 1 changed file with 64 additions and 2 deletions.
66 changes: 64 additions & 2 deletions openapispec/unified/XI-Resellers-API-Spec.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8291,6 +8291,7 @@ components:
properties:
quoteNumber:
type: string
nullable: true
description: A unique identifier generated by Ingram Micro's CRM specific to each quote.
maxLength: 35
customerOrderNumber:
Expand All @@ -8310,179 +8311,228 @@ components:
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
nullable: true
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
nullable: true
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.
vendAuthNumber:
type: string
nullable: true
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
nullable: true
description: The address and contact information provided by the reseller.
properties:
resellerId:
type: string
nullable: true
description: The reseller's Id.
companyName:
type: string
nullable: true
maxLength: 40
description: The reseller's company name.
contact:
type: string
nullable: true
description: The reseller's contact name.
addressLine1:
type: string
nullable: true
description: The reseller's address line 1
addressLine2:
type: string
nullable: true
description: The reseller's address line 2.
city:
type: string
nullable: true
description: The reseller's city.
state:
type: string
nullable: true
description: The reseller's state.
postalCode:
type: string
nullable: true
maxLength: 10
description: The reseller's zip or postal code.
countryCode:
type: string
nullable: true
maxLength: 10
description: The reseller's two-character ISO country code.
phoneNumber:
type: integer
type: string
nullable: true
description: The reseller's phone number.
email:
type: string
nullable: true
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
nullable: true
description: ID for the end user/customer in Ingram Micro's system.
contact:
type: string
nullable: true
description: The contact name for the end user/customer.
companyName:
type: string
nullable: true
description: The company name for the end user/customer. Required for Impulse countries.
maxLength: 40
addressLine1:
type: string
nullable: true
description: The end user/customer's street address and building or house number. Required for Impulse countries.
maxLength: 70
addressLine2:
type: string
nullable: true
description: The end user/customer's apartment number.
maxLength: 70
city:
type: string
nullable: true
description: The end user/customer's city. Required for Impulse countries.
maxLength: 25
state:
type: string
nullable: true
description: The end user/customer's state. Required for Impulse countries but optional for EMEA countries.
maxLength: 3
postalCode:
type: string
nullable: true
description: The end user/customer's zip or postal code. Required for Impulse countries.
maxLength: 10
countryCode:
type: string
nullable: true
description: The end user/customer's two-character ISO country code.
maxLength: 10
phoneNumber:
type: integer
type: string
nullable: true
description: The end user/customer's phone number.
email:
type: string
nullable: true
description: The end user/customer's email.
shipToInfo:
type: object
nullable: true
description: The shipping information provided by the reseller.
properties:
addressId:
type: string
nullable: true
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
nullable: true
description: The company contact provided by the reseller.
maxLength: 70
companyName:
type: string
nullable: true
description: The reseller's company name or the End-User's Name
maxLength: 40
addressLine1:
type: string
nullable: true
description: The street address and building or house number the order will be shipped to.
maxLength: 70
addressLine2:
type: string
nullable: true
description: The apartment number the order will be shipped to.
maxLength: 70
city:
type: string
nullable: true
description: The city the order will be shipped to.
maxLength: 25
state:
type: string
nullable: true
description: The state the order will be shipped to.
maxLength: 3
postalCode:
type: string
nullable: true
description: End User Name
countryCode:
type: string
nullable: true
description: The zip or postal code the order will be shipped to.
maxLength: 10
email:
type: string
nullable: true
description: The company contact email address.
shippingNotes:
type: string
nullable: true
description: ''
phoneNumber:
type: string
nullable: true
description: The company contact phone number.
shipmentDetails:
type: object
nullable: true
description: Shipping details for the order provided by the customer.
properties:
carrierCode:
type: string
nullable: true
description: The code for the shipping carrier for the line item.
maxLength: 10
requestedDeliveryDate:
type: string
nullable: true
description: The reseller-requested delivery date in UTC format. Delivery date is not guaranteed. Must be a future date.
maxLength: 8
shipComplete:
type: string
nullable: true
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
nullable: true
description: Any special shipping instructions for the order.
maxLength: 132
freightAccountNumber:
type: string
nullable: true
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
nullable: true
description: Specifies whether a signature is required for delivery. Default is False.
additionalAttributes:
type: array
nullable: true
description: Shipment-level additional attributes.
items:
type: object
nullable: true
properties:
attributeName:
type: string
nullable: true
description: |-
**allowPartialOrder:** Allow orders with failed lines.

Expand Down Expand Up @@ -8514,18 +8564,23 @@ components:
**allowOrderOnCustomerHold:** Boolean value flag which allows a customer to create an order with the hold status.
attributeValue:
type: string
nullable: true
description: The attribute field data.
vmfAdditionalAttributes:
type: array
nullable: true
description: The object containing the list of fields required at a header level by the vendor.
items:
type: object
nullable: true
properties:
attributeName:
type: string
nullable: true
description: The name of the header level field.
attributeValue:
type: string
nullable: true
description: The value of the header level field.
lines:
type: array
Expand All @@ -8538,31 +8593,38 @@ components:
maxLength: 3
ingramPartNumber:
type: string
nullable: true
description: The unique IngramMicro part number.
maxLength: 18
vendorPartNumber:
type: string
nullable: true
description: The vendor's part number for the line item.
quantity:
type: integer
description: The requested quantity of the line item.
unitPrice:
type: number
format: decimal
nullable: true
description: The reseller-requested unit price for the line item. The unit price is not guaranteed.
specialBidNumber:
type: string
nullable: true
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: number
format: decimal
nullable: true
description: The end-user price. Required for Export Orders.
notes:
type: string
nullable: true
description: The attribute field data.
endUserInfo:
type: array
nullable: true
items:
type: object
properties:
Expand Down

0 comments on commit c3b326f

Please sign in to comment.