Structure of OrderCreateRequest
| Field Name | DataType | Required | Instances | Minimum Usage | Maximum Usage | Minimum Length | Maximum Length | XPath | Documentation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| OrderCreateRequest | AnyType | Yes | 1 | 1 | |||||||||||||||||
| Order | AnyType | Yes | 1 | 1 | |||||||||||||||||
| Customer | AnyType | Yes | 1 | 1 | |||||||||||||||||
| Name | AnyType | Yes | 1 | 1 | |||||||||||||||||
| Honirific | String | Yes | 1 | 1 | |||||||||||||||||
| LastName | String | Yes | 1 | 1 | |||||||||||||||||
| MiddleName | String | No | 0 | 1 | |||||||||||||||||
| FirstName | String | Yes | 1 | 1 | |||||||||||||||||
| Any | AnyType | No | 0 | unbounded | |||||||||||||||||
| Gender | AnyType | No | 0 | unbounded | |||||||||||||||||
| DateOfBirth | Date | No | 0 | 1 | 150 | ||||||||||||||||
| EmailAddress | String | No | 0 | 1 | 40 | ||||||||||||||||
| CustomerTaxId | String | No | 0 | 1 | |||||||||||||||||
| TaxExemptFlag | boolean | No | 0 | 1 | |||||||||||||||||
| LoyaltyPrograms | AnyType | No | 0 | ||||||||||||||||||
| LoyaltyProgram | AnyType | Yes | 1 | unbounded | |||||||||||||||||
| Account | String | Yes | 1 | 1 | |||||||||||||||||
| Program | String | Yes | 1 | 1 | |||||||||||||||||
| CustomAttributes -(Refer to CustomAttributesType*** below) | AnyType | No | 0 | 1 | |||||||||||||||||
| attribute: id | ID | No | |||||||||||||||||||
| attribute: customerId | String | No | 1 | 40 | |||||||||||||||||
| CreateTime | DateTime | Yes | 1 | 1 | |||||||||||||||||
| OrderItems | |||||||||||||||||||||
| OrderItem (OrderItemRequestType***) | AnyType | Yes | 1 | unbounded | |||||||||||||||||
| ItemId | String | Yes | 1 | 1 | 1 | 20 | |||||||||||||||
| Quantity | Decimal | Yes | 1 | 1 | |||||||||||||||||
| Description | AnyType | No | 0 | 1 | |||||||||||||||||
| Color | String | No | 0 | 1 | |||||||||||||||||
| attribute: id | Yes | ||||||||||||||||||||
| Size | String | No | 0 | 1 | |||||||||||||||||
| attribute: id | Yes | ||||||||||||||||||||
| ScreenSize | String | No | 0 | 1 | |||||||||||||||||
| Department | String | No | 0 | 1 | |||||||||||||||||
| Pricing (OrderItemPricingRequest*** type) | AnyType | Yes | 1 | 1 | |||||||||||||||||
| Merchandise (PriceGroupRequestType***) | AnyType | Yes | 1 | 1 | |||||||||||||||||
| Amount | Decimal | No | 0 | 1 | |||||||||||||||||
| attribute: remainder | No | ||||||||||||||||||||
| PromotionalDiscounts | AnyType | No | 0 | 1 | |||||||||||||||||
| Discount | AnyType | Yes | 1 | unbounded | |||||||||||||||||
| Id | String | Yes | 1 | 1 | |||||||||||||||||
| Code | String | No | 0 | 1 | |||||||||||||||||
| Amount | Decimal | Yes | 1 | 1 | |||||||||||||||||
| Description | String | No | 0 | 1 | |||||||||||||||||
| EffectType | String | No | 0 | 1 | |||||||||||||||||
| TaxData -OrderTaxData*** type | AnyType | No | 0 | 1 | |||||||||||||||||
| TaxClass | String | No | 0 | 1 | |||||||||||||||||
| Taxes | AnyType | No | 0 | 1 | |||||||||||||||||
| Tax | AnyType | Yes | 1 | unbounded | |||||||||||||||||
| Situs | String | Yes | 1 | 1 | |||||||||||||||||
| Jurisdiction | AnyType | No | 0 | 1 | |||||||||||||||||
| attribute: jurisdictionLevel | String | Yes | 1 | 1 | |||||||||||||||||
| attribute: jurisdictionId | String | Yes | 1 | 1 | |||||||||||||||||
| Imposition | AnyType | No | 0 | 1 | |||||||||||||||||
| attribute: impositionType | String | No | |||||||||||||||||||
| EffectiveRate | Decimal | Yes | 1 | 1 | |||||||||||||||||
| TaxableAmount | Decimal | No | 0 | 1 | |||||||||||||||||
| CalculatedTax | Decimal | Yes | 1 | 1 | |||||||||||||||||
| SellerRegistrationId | String | No | 0 | 1 | Enumeration - TAXABLE|NONTAXABLE|EXEMPT|DPPAPPLIED|NO_TAX|DEFERRED | ||||||||||||||||
| attribute: taxType | String | Yes | |||||||||||||||||||
| attribute: taxability (Taxability*** type) | String | No | |||||||||||||||||||
| attribute:appliedCount | Integer | No | |||||||||||||||||||
| TaxData - Refer to OrderTaxData *** above | AnyType | No | 0 | 1 | |||||||||||||||||
| UnitPrice | Decimal | No | 0 | 1 | |||||||||||||||||
| Shipping - (Refer to PriceGroupRequestType*** above) | |||||||||||||||||||||
| Item- (Refer to PriceGroupRequestType*** above) | |||||||||||||||||||||
| Fees - PriceRequestFeeListType*** | |||||||||||||||||||||
| Fee - PriceRequestFeeType*** | |||||||||||||||||||||
| FeeType | |||||||||||||||||||||
| Description | |||||||||||||||||||||
| Amount | |||||||||||||||||||||
| ItemId | |||||||||||||||||||||
| TaxData - TaxData *** | |||||||||||||||||||||
| TaxClass | |||||||||||||||||||||
| Taxes (TaxGroup*** type) | |||||||||||||||||||||
| Tax(Tax*** type) | |||||||||||||||||||||
| Situs | |||||||||||||||||||||
| Jurisdiction | |||||||||||||||||||||
| attribute: jurisdictionLevel | |||||||||||||||||||||
| attribute: jurisdictionId | |||||||||||||||||||||
| Imposition | |||||||||||||||||||||
| attribute: impositionType | |||||||||||||||||||||
| EffectiveRate | |||||||||||||||||||||
| TaxableAmount | |||||||||||||||||||||
| NonTaxableAmount | |||||||||||||||||||||
| CalculatedTax | |||||||||||||||||||||
| SellerRegistrationId | |||||||||||||||||||||
| InvoiceTextCodes | |||||||||||||||||||||
| InvoiceTextCode | |||||||||||||||||||||
| Extension | enumeration - SALES|SELLER_USE| CONSUMERS_USE| VAT| IMPORT_VAT| NONE | ||||||||||||||||||||
| attribute: taxType | |||||||||||||||||||||
| attribute: taxability (Refer to Taxability*** type) | |||||||||||||||||||||
| Extension | |||||||||||||||||||||
| ShippingProgram | |||||||||||||||||||||
| attribute: authToken | |||||||||||||||||||||
| ShippingMethod | |||||||||||||||||||||
| attribute: displayText | |||||||||||||||||||||
| StoreFrontDetails (StoreFrontDetails*** type) | |||||||||||||||||||||
| StoreFrontLocation | |||||||||||||||||||||
| StoreCode | |||||||||||||||||||||
| StoreName | |||||||||||||||||||||
| StoreEmail | |||||||||||||||||||||
| Address (PhysicalAddressType***) | |||||||||||||||||||||
| Line1 | |||||||||||||||||||||
| Line2 | |||||||||||||||||||||
| Line3 | |||||||||||||||||||||
| Line4 | |||||||||||||||||||||
| City | |||||||||||||||||||||
| MainDivision | |||||||||||||||||||||
| CountryCode | |||||||||||||||||||||
| PostalCOde | |||||||||||||||||||||
| Extension | |||||||||||||||||||||
| Phone | |||||||||||||||||||||
| attribute: id | |||||||||||||||||||||
| StoreDirections | |||||||||||||||||||||
| StoreHours | Enumeration [SHIP_TO_STORE|STORE_PICK_UP|SHIP_TO_HOME|STORE_RESERVATION] | ||||||||||||||||||||
| StoreFrontPhoneNumber | |||||||||||||||||||||
| FulfillmentChannel (FulfillmentType*** ) | |||||||||||||||||||||
| ProxyPickupDetails | |||||||||||||||||||||
| PersonName | |||||||||||||||||||||
| FirstName | |||||||||||||||||||||
| LastName | |||||||||||||||||||||
| Phone | |||||||||||||||||||||
| Address (Refer to PhysicalAddressType*** above) | |||||||||||||||||||||
| Relationship | |||||||||||||||||||||
| EstimatedDeliveryDate (EstimatedDeliveryDateType***) | |||||||||||||||||||||
| DeliveryWindow (DateRangeType***) | |||||||||||||||||||||
| From | |||||||||||||||||||||
| To | Enumaration[CALIBRATION|ENABLED|LEGACY] | ||||||||||||||||||||
| ShippingWindow (Refer to DateRangeType*** above) | |||||||||||||||||||||
| Mode (DeliveryEstimateMode*** ) | |||||||||||||||||||||
| MessageType | |||||||||||||||||||||
| Template | |||||||||||||||||||||
| NamedDeliveryDate (NamedDeliveryDateType***) | |||||||||||||||||||||
| DeliveryDate | |||||||||||||||||||||
| TimeWindowStart | |||||||||||||||||||||
| TimeWindowEnd | |||||||||||||||||||||
| Message | |||||||||||||||||||||
| DeliveryInstructions | |||||||||||||||||||||
| VendorId | |||||||||||||||||||||
| VendorName | |||||||||||||||||||||
| Gifting(GiftRequestType***) | |||||||||||||||||||||
| Gift | |||||||||||||||||||||
| ItemId | |||||||||||||||||||||
| Pricing (Refer tob PriceGroupRequestType*** above) | |||||||||||||||||||||
| Message (GiftMessage*** type) | |||||||||||||||||||||
| To (MessageFieldType***) | |||||||||||||||||||||
| attribute: localizedDisplayText | |||||||||||||||||||||
| From (Refer to MessageFieldType*** above) | |||||||||||||||||||||
| Message | |||||||||||||||||||||
| GiftCard (PackslipType***) | |||||||||||||||||||||
| Message ( Refer to GiftMessage*** type above) | |||||||||||||||||||||
| Packslip (Refer to PackslipType*** above) | |||||||||||||||||||||
| ShopRunnerMessage | |||||||||||||||||||||
| Customization (CustomizationServiceRequestType***) | |||||||||||||||||||||
| Customizations | |||||||||||||||||||||
| Customization | |||||||||||||||||||||
| CustomizationId | |||||||||||||||||||||
| Instructions (CustomizationInstructions***) | |||||||||||||||||||||
| Instructions | |||||||||||||||||||||
| Key | |||||||||||||||||||||
| Value (CustomizationTextType***) | |||||||||||||||||||||
| DisplayTitle (Refer to CustomizationTextType*** above) | |||||||||||||||||||||
| DisplayValue (Refer to CustomizationTextType*** above) | |||||||||||||||||||||
| ExtendedPrice (Refer to PriceGroupRequestType*** above) | |||||||||||||||||||||
| ItemId | |||||||||||||||||||||
| Item (OrderItemReference*** type) | |||||||||||||||||||||
| attribute: ref | |||||||||||||||||||||
| BasePrice (Refer to PriceGroupRequestType*** above) | |||||||||||||||||||||
| DisplayUrl | |||||||||||||||||||||
| SerialNumber | |||||||||||||||||||||
| CustomAttributes (CustomAttributesType***) | |||||||||||||||||||||
| Attribute | 1 | unbounded | |||||||||||||||||||
| Key | String | Yes | 1 | 1 | |||||||||||||||||
| Value | Normalized String | Yes | 1 | 1 | |||||||||||||||||
| GiftRegistryCancelUrl | |||||||||||||||||||||
| ReservationId | |||||||||||||||||||||
| HTSCode | |||||||||||||||||||||
| attribute: id | |||||||||||||||||||||
| attribute: webLineId | |||||||||||||||||||||
| attribute: webSubLineId | |||||||||||||||||||||
| attribute: isHiddenGift | |||||||||||||||||||||
| attribute: taxAndDutyDisplay | |||||||||||||||||||||
| attribute: isSubscribable | |||||||||||||||||||||
| attribute: subscriptionRef | |||||||||||||||||||||
| attribute: actionType | |||||||||||||||||||||
| Shipping (ShippingRequestType***) | |||||||||||||||||||||
| ShipGroups | |||||||||||||||||||||
| ShipGroup (ShipGroupRequestType***) | |||||||||||||||||||||
| DestinationTarget | |||||||||||||||||||||
| attribute: ref | |||||||||||||||||||||
| OrderItems | |||||||||||||||||||||
| Item | |||||||||||||||||||||
| attribute: ref | |||||||||||||||||||||
| Gifting(Refer to GiftRequestType*** above) | |||||||||||||||||||||
| attribute: id | |||||||||||||||||||||
| attribute: chargeType | |||||||||||||||||||||
For more information on this API, see Create Order.