POST api/orders/estimate
Estimates an order.
Request Information
URI Parameters
None.
Body Parameters
An order creation request containing the order's details.
OrderCreationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
Represents the Id of the company the order is to be placed for. |
integer |
Minimum value: 1 |
| LocationId |
Represents the Id of the company's location the order is to be placed for. |
integer |
Minimum value: 1 |
| PricingSheetId |
Represents the Id of the pricing sheet the order is to be priced by. |
integer |
Minimum value: 1 |
| ShopLocationId |
Represents the Id of the ABC Shop Location to send the order to. The location must be an AbcShop, FM, or VFM. |
integer |
Minimum value: 1 |
| Comment |
A order comment. Place any additional production notes you may have here. |
string |
String length: inclusive between 0 and 4000 |
| PrintCommentOnWorkOrder |
Should the comment be printed on the work order. |
boolean |
Default value is False |
| Comment2 |
A second comment to put on the order. |
string |
String length: inclusive between 0 and 4000 |
| PrintComment2OnWorkOrder |
Should the secondary comment be printed on the work order. |
boolean |
Default value is False |
| PurchaseOrderNumber |
The purchase order number to reference on this order. |
string |
String length: inclusive between 0 and 20 |
| ProjectNumber |
The project number to reference on this order. |
string |
String length: inclusive between 0 and 100 |
| ProjectName |
The project name to reference on this order. |
string |
String length: inclusive between 0 and 100 |
| DueDateTime |
The date and time the order is desired. |
date |
Time Delta: Must be at least 02:00:00 in the future. |
| OrderedBy |
Who actually placed the order. |
string |
String length: inclusive between 0 and 60 |
| Lines |
A list of items you wish to request on this order. |
Collection of OrderCreationRequestLine |
None. |
| Shipments |
A list of shipments you wish to request with this order. |
Collection of OrderCreationRequestShipment |
None. |
| Payments |
A list of payments to pay off the order. |
Collection of OrderCreationPayment |
None. |
| NotifyShopOfNewOrder |
Should a notification be sent to the ABC Shop of the new order |
boolean |
Default value is False |
| AdditionalNotificationEmailAddresses |
Semicolon (;) separated list of email address that are to be copied on the notification to the shop. |
string |
None. |
| CreateCodOrder |
Should the work order be created as a Collect On Delivery order. |
boolean |
Default value is False |
| OrderedByEmail |
The email of the person placing the order. |
string |
String length: inclusive between 0 and 128 |
| OrderedByPhoneNumber |
The phone number of the person placing the order. |
string |
String length: inclusive between 0 and 30 |
| OrderedByCompanyName |
The company name of the person placing the order. Ignored on non-COD orders. |
string |
String length: inclusive between 0 and 100 |
| CodAddress |
Address information for the ordered by on a COD order. Ignored on non-COD orders. |
OrderCreationRequestAddress |
None. |
| OrderedByAddress |
Address information for the ordered by on a order. Ignored on COD orders. |
OrderCreationRequestAddress |
None. |
| OrderSource |
Source of the order. Only set if requested. |
OrderSource |
None. |
| OverrideShippingProfileId |
Desired alternate shipping profile id. Null will use default profile. |
integer |
Minimum value: 1 |
Request Formats
application/json, text/json
{
"CompanyId": 1,
"LocationId": 1,
"PricingSheetId": 1,
"ShopLocationId": 1,
"Comment": "sample string 1",
"PrintCommentOnWorkOrder": true,
"Comment2": "sample string 3",
"PrintComment2OnWorkOrder": true,
"PurchaseOrderNumber": "sample string 5",
"ProjectNumber": "sample string 6",
"ProjectName": "sample string 7",
"DueDateTime": "2025-12-01T20:40:19.2745762-05:00",
"OrderedBy": "sample string 8",
"Lines": [
{
"ItemCode": "sample string 1",
"Originals": 2,
"Copies": 3,
"Description": "sample string 4",
"Sequence": 1,
"AdditionalDetails": "sample string 5",
"WidthInInches": 1.0,
"LenghtInInches": 1.0,
"SizeInSquareFeet": 1.0,
"OverrideUnitPrice": 1.0,
"PackageAllocations": [
{
"CopyCount": 1,
"PackageId": 2
},
{
"CopyCount": 1,
"PackageId": 2
}
],
"ShopLocationId": 1
},
{
"ItemCode": "sample string 1",
"Originals": 2,
"Copies": 3,
"Description": "sample string 4",
"Sequence": 1,
"AdditionalDetails": "sample string 5",
"WidthInInches": 1.0,
"LenghtInInches": 1.0,
"SizeInSquareFeet": 1.0,
"OverrideUnitPrice": 1.0,
"PackageAllocations": [
{
"CopyCount": 1,
"PackageId": 2
},
{
"CopyCount": 1,
"PackageId": 2
}
],
"ShopLocationId": 1
}
],
"Shipments": [
{
"ShippingMethod": 1,
"DescriptionOverride": "sample string 1",
"TaxCode": "sample string 2",
"ShipToEmail": "sample string 3",
"ShipToAddressValidated": true,
"ShipFromAddressOverride": {
"Street1": "sample string 1",
"Street2": "sample string 2",
"Street3": "sample string 3",
"City": "sample string 4",
"Region": "sample string 5",
"Postalcode": "sample string 6",
"PostalZip4": "sample string 7",
"CountryCode": "sample string 8"
},
"ShipFromPhoneNumberOverride": "sample string 4",
"ShipFromEmailOverride": "sample string 5",
"ShipFromCompanyOverride": "sample string 6",
"UseCustomerAccountForShipping": true,
"CustomerShippingAccountCode": "sample string 8",
"Packages": [
{
"Description": "sample string 1",
"HandlingChargeCode": "sample string 2",
"ManualHandlingChargeNatural": 1.0,
"PackagingChargeCode": "sample string 3",
"ManualPackagingChargeNatural": 1.0,
"ReferenceId": 1,
"PackageTypeCode": "sample string 4",
"EstimatedWeightInPounds": 1.1,
"EstimatedHeightInInches": 1.1,
"EstimatedWidthInInches": 1.1,
"EstimatedLengthInInches": 1.1,
"EstimatedDeclaredValue": 1.0
},
{
"Description": "sample string 1",
"HandlingChargeCode": "sample string 2",
"ManualHandlingChargeNatural": 1.0,
"PackagingChargeCode": "sample string 3",
"ManualPackagingChargeNatural": 1.0,
"ReferenceId": 1,
"PackageTypeCode": "sample string 4",
"EstimatedWeightInPounds": 1.1,
"EstimatedHeightInInches": 1.1,
"EstimatedWidthInInches": 1.1,
"EstimatedLengthInInches": 1.1,
"EstimatedDeclaredValue": 1.0
}
],
"Notifications": [
{
"EmailAddress": "sample string 1",
"NotificationOption": 0
},
{
"EmailAddress": "sample string 1",
"NotificationOption": 0
}
],
"CustomLabelDataHeader": "sample string 9",
"CustomLabelDataValue": "sample string 10",
"ShippingServiceCode": "sample string 11",
"ShipToCompany": "sample string 12",
"ShipToAttention": "sample string 13",
"ShipToAddress": {
"Street1": "sample string 1",
"Street2": "sample string 2",
"Street3": "sample string 3",
"City": "sample string 4",
"Region": "sample string 5",
"Postalcode": "sample string 6",
"PostalZip4": "sample string 7",
"CountryCode": "sample string 8"
},
"ShipToPhoneNumber": "sample string 14",
"ShipToLocationId": 1,
"ShipToAddressBookEntryId": 1,
"ShipToIsResidential": true,
"SaturdayDelivery": true,
"SignatureRequired": true,
"ShipmentReadyDateTimeLocal": "2025-12-01T20:40:19.2745762-05:00",
"CustomerCloseTimeLocal": "2025-12-01T20:40:19.2745762-05:00"
},
{
"ShippingMethod": 1,
"DescriptionOverride": "sample string 1",
"TaxCode": "sample string 2",
"ShipToEmail": "sample string 3",
"ShipToAddressValidated": true,
"ShipFromAddressOverride": {
"Street1": "sample string 1",
"Street2": "sample string 2",
"Street3": "sample string 3",
"City": "sample string 4",
"Region": "sample string 5",
"Postalcode": "sample string 6",
"PostalZip4": "sample string 7",
"CountryCode": "sample string 8"
},
"ShipFromPhoneNumberOverride": "sample string 4",
"ShipFromEmailOverride": "sample string 5",
"ShipFromCompanyOverride": "sample string 6",
"UseCustomerAccountForShipping": true,
"CustomerShippingAccountCode": "sample string 8",
"Packages": [
{
"Description": "sample string 1",
"HandlingChargeCode": "sample string 2",
"ManualHandlingChargeNatural": 1.0,
"PackagingChargeCode": "sample string 3",
"ManualPackagingChargeNatural": 1.0,
"ReferenceId": 1,
"PackageTypeCode": "sample string 4",
"EstimatedWeightInPounds": 1.1,
"EstimatedHeightInInches": 1.1,
"EstimatedWidthInInches": 1.1,
"EstimatedLengthInInches": 1.1,
"EstimatedDeclaredValue": 1.0
},
{
"Description": "sample string 1",
"HandlingChargeCode": "sample string 2",
"ManualHandlingChargeNatural": 1.0,
"PackagingChargeCode": "sample string 3",
"ManualPackagingChargeNatural": 1.0,
"ReferenceId": 1,
"PackageTypeCode": "sample string 4",
"EstimatedWeightInPounds": 1.1,
"EstimatedHeightInInches": 1.1,
"EstimatedWidthInInches": 1.1,
"EstimatedLengthInInches": 1.1,
"EstimatedDeclaredValue": 1.0
}
],
"Notifications": [
{
"EmailAddress": "sample string 1",
"NotificationOption": 0
},
{
"EmailAddress": "sample string 1",
"NotificationOption": 0
}
],
"CustomLabelDataHeader": "sample string 9",
"CustomLabelDataValue": "sample string 10",
"ShippingServiceCode": "sample string 11",
"ShipToCompany": "sample string 12",
"ShipToAttention": "sample string 13",
"ShipToAddress": {
"Street1": "sample string 1",
"Street2": "sample string 2",
"Street3": "sample string 3",
"City": "sample string 4",
"Region": "sample string 5",
"Postalcode": "sample string 6",
"PostalZip4": "sample string 7",
"CountryCode": "sample string 8"
},
"ShipToPhoneNumber": "sample string 14",
"ShipToLocationId": 1,
"ShipToAddressBookEntryId": 1,
"ShipToIsResidential": true,
"SaturdayDelivery": true,
"SignatureRequired": true,
"ShipmentReadyDateTimeLocal": "2025-12-01T20:40:19.2745762-05:00",
"CustomerCloseTimeLocal": "2025-12-01T20:40:19.2745762-05:00"
}
],
"Payments": [
{
"ConfirmationNumber": "sample string 1"
},
{
"ConfirmationNumber": "sample string 1"
}
],
"NotifyShopOfNewOrder": true,
"AdditionalNotificationEmailAddresses": "sample string 10",
"CreateCodOrder": true,
"OrderedByEmail": "sample string 12",
"OrderedByPhoneNumber": "sample string 13",
"OrderedByCompanyName": "sample string 14",
"CodAddress": {
"Street1": "sample string 1",
"Street2": "sample string 2",
"City": "sample string 3",
"Region": "sample string 4",
"Postalcode": "sample string 5",
"CountryCode": "sample string 6"
},
"OrderedByAddress": {
"Street1": "sample string 1",
"Street2": "sample string 2",
"City": "sample string 3",
"Region": "sample string 4",
"Postalcode": "sample string 5",
"CountryCode": "sample string 6"
},
"OrderSource": 1,
"OverrideShippingProfileId": 1
}
application/xml, text/xml
<OrderCreationRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CompanyId>1</CompanyId>
<LocationId>1</LocationId>
<PricingSheetId>1</PricingSheetId>
<ShopLocationId>1</ShopLocationId>
<Comment>sample string 1</Comment>
<PrintCommentOnWorkOrder>true</PrintCommentOnWorkOrder>
<Comment2>sample string 3</Comment2>
<PrintComment2OnWorkOrder>true</PrintComment2OnWorkOrder>
<PurchaseOrderNumber>sample string 5</PurchaseOrderNumber>
<ProjectNumber>sample string 6</ProjectNumber>
<ProjectName>sample string 7</ProjectName>
<DueDateTime>2025-12-01T20:40:19.2745762-05:00</DueDateTime>
<OrderedBy>sample string 8</OrderedBy>
<Lines>
<OrderCreationRequestLine>
<ItemCode>sample string 1</ItemCode>
<Originals>2</Originals>
<Copies>3</Copies>
<Description>sample string 4</Description>
<Sequence>1</Sequence>
<AdditionalDetails>sample string 5</AdditionalDetails>
<WidthInInches>1</WidthInInches>
<LenghtInInches>1</LenghtInInches>
<SizeInSquareFeet>1</SizeInSquareFeet>
<OverrideUnitPrice>1</OverrideUnitPrice>
<PackageAllocations>
<OrderCreationRequestLinePackageAllocation>
<CopyCount>1</CopyCount>
<PackageId>2</PackageId>
</OrderCreationRequestLinePackageAllocation>
<OrderCreationRequestLinePackageAllocation>
<CopyCount>1</CopyCount>
<PackageId>2</PackageId>
</OrderCreationRequestLinePackageAllocation>
</PackageAllocations>
<ShopLocationId>1</ShopLocationId>
</OrderCreationRequestLine>
<OrderCreationRequestLine>
<ItemCode>sample string 1</ItemCode>
<Originals>2</Originals>
<Copies>3</Copies>
<Description>sample string 4</Description>
<Sequence>1</Sequence>
<AdditionalDetails>sample string 5</AdditionalDetails>
<WidthInInches>1</WidthInInches>
<LenghtInInches>1</LenghtInInches>
<SizeInSquareFeet>1</SizeInSquareFeet>
<OverrideUnitPrice>1</OverrideUnitPrice>
<PackageAllocations>
<OrderCreationRequestLinePackageAllocation>
<CopyCount>1</CopyCount>
<PackageId>2</PackageId>
</OrderCreationRequestLinePackageAllocation>
<OrderCreationRequestLinePackageAllocation>
<CopyCount>1</CopyCount>
<PackageId>2</PackageId>
</OrderCreationRequestLinePackageAllocation>
</PackageAllocations>
<ShopLocationId>1</ShopLocationId>
</OrderCreationRequestLine>
</Lines>
<Shipments>
<OrderCreationRequestShipment>
<ShippingMethod>Ups</ShippingMethod>
<ShippingServiceCode>sample string 11</ShippingServiceCode>
<ShipToCompany>sample string 12</ShipToCompany>
<ShipToAttention>sample string 13</ShipToAttention>
<ShipToAddress>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<Street3>sample string 3</Street3>
<City>sample string 4</City>
<Region>sample string 5</Region>
<Postalcode>sample string 6</Postalcode>
<PostalZip4>sample string 7</PostalZip4>
<CountryCode>sample string 8</CountryCode>
</ShipToAddress>
<ShipToPhoneNumber>sample string 14</ShipToPhoneNumber>
<ShipToLocationId>1</ShipToLocationId>
<ShipToAddressBookEntryId>1</ShipToAddressBookEntryId>
<ShipToIsResidential>true</ShipToIsResidential>
<SaturdayDelivery>true</SaturdayDelivery>
<SignatureRequired>true</SignatureRequired>
<ShipmentReadyDateTimeLocal>2025-12-01T20:40:19.2745762-05:00</ShipmentReadyDateTimeLocal>
<CustomerCloseTimeLocal>2025-12-01T20:40:19.2745762-05:00</CustomerCloseTimeLocal>
<Packages>
<OrderCreationRequestShipmentPackage>
<ReferenceId>1</ReferenceId>
<PackageTypeCode>sample string 4</PackageTypeCode>
<EstimatedWeightInPounds>1.1</EstimatedWeightInPounds>
<EstimatedHeightInInches>1.1</EstimatedHeightInInches>
<EstimatedWidthInInches>1.1</EstimatedWidthInInches>
<EstimatedLengthInInches>1.1</EstimatedLengthInInches>
<EstimatedDeclaredValue>1</EstimatedDeclaredValue>
<Description>sample string 1</Description>
<HandlingChargeCode>sample string 2</HandlingChargeCode>
<ManualHandlingChargeNatural>1</ManualHandlingChargeNatural>
<PackagingChargeCode>sample string 3</PackagingChargeCode>
<ManualPackagingChargeNatural>1</ManualPackagingChargeNatural>
</OrderCreationRequestShipmentPackage>
<OrderCreationRequestShipmentPackage>
<ReferenceId>1</ReferenceId>
<PackageTypeCode>sample string 4</PackageTypeCode>
<EstimatedWeightInPounds>1.1</EstimatedWeightInPounds>
<EstimatedHeightInInches>1.1</EstimatedHeightInInches>
<EstimatedWidthInInches>1.1</EstimatedWidthInInches>
<EstimatedLengthInInches>1.1</EstimatedLengthInInches>
<EstimatedDeclaredValue>1</EstimatedDeclaredValue>
<Description>sample string 1</Description>
<HandlingChargeCode>sample string 2</HandlingChargeCode>
<ManualHandlingChargeNatural>1</ManualHandlingChargeNatural>
<PackagingChargeCode>sample string 3</PackagingChargeCode>
<ManualPackagingChargeNatural>1</ManualPackagingChargeNatural>
</OrderCreationRequestShipmentPackage>
</Packages>
<DescriptionOverride>sample string 1</DescriptionOverride>
<TaxCode>sample string 2</TaxCode>
<ShipToEmail>sample string 3</ShipToEmail>
<ShipToAddressValidated>true</ShipToAddressValidated>
<ShipFromAddressOverride>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<Street3>sample string 3</Street3>
<City>sample string 4</City>
<Region>sample string 5</Region>
<Postalcode>sample string 6</Postalcode>
<PostalZip4>sample string 7</PostalZip4>
<CountryCode>sample string 8</CountryCode>
</ShipFromAddressOverride>
<ShipFromPhoneNumberOverride>sample string 4</ShipFromPhoneNumberOverride>
<ShipFromEmailOverride>sample string 5</ShipFromEmailOverride>
<ShipFromCompanyOverride>sample string 6</ShipFromCompanyOverride>
<UseCustomerAccountForShipping>true</UseCustomerAccountForShipping>
<CustomerShippingAccountCode>sample string 8</CustomerShippingAccountCode>
<Notifications>
<ShipmentEmailNotification>
<EmailAddress>sample string 1</EmailAddress>
<NotificationOption>None</NotificationOption>
</ShipmentEmailNotification>
<ShipmentEmailNotification>
<EmailAddress>sample string 1</EmailAddress>
<NotificationOption>None</NotificationOption>
</ShipmentEmailNotification>
</Notifications>
<CustomLabelDataHeader>sample string 9</CustomLabelDataHeader>
<CustomLabelDataValue>sample string 10</CustomLabelDataValue>
</OrderCreationRequestShipment>
<OrderCreationRequestShipment>
<ShippingMethod>Ups</ShippingMethod>
<ShippingServiceCode>sample string 11</ShippingServiceCode>
<ShipToCompany>sample string 12</ShipToCompany>
<ShipToAttention>sample string 13</ShipToAttention>
<ShipToAddress>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<Street3>sample string 3</Street3>
<City>sample string 4</City>
<Region>sample string 5</Region>
<Postalcode>sample string 6</Postalcode>
<PostalZip4>sample string 7</PostalZip4>
<CountryCode>sample string 8</CountryCode>
</ShipToAddress>
<ShipToPhoneNumber>sample string 14</ShipToPhoneNumber>
<ShipToLocationId>1</ShipToLocationId>
<ShipToAddressBookEntryId>1</ShipToAddressBookEntryId>
<ShipToIsResidential>true</ShipToIsResidential>
<SaturdayDelivery>true</SaturdayDelivery>
<SignatureRequired>true</SignatureRequired>
<ShipmentReadyDateTimeLocal>2025-12-01T20:40:19.2745762-05:00</ShipmentReadyDateTimeLocal>
<CustomerCloseTimeLocal>2025-12-01T20:40:19.2745762-05:00</CustomerCloseTimeLocal>
<Packages>
<OrderCreationRequestShipmentPackage>
<ReferenceId>1</ReferenceId>
<PackageTypeCode>sample string 4</PackageTypeCode>
<EstimatedWeightInPounds>1.1</EstimatedWeightInPounds>
<EstimatedHeightInInches>1.1</EstimatedHeightInInches>
<EstimatedWidthInInches>1.1</EstimatedWidthInInches>
<EstimatedLengthInInches>1.1</EstimatedLengthInInches>
<EstimatedDeclaredValue>1</EstimatedDeclaredValue>
<Description>sample string 1</Description>
<HandlingChargeCode>sample string 2</HandlingChargeCode>
<ManualHandlingChargeNatural>1</ManualHandlingChargeNatural>
<PackagingChargeCode>sample string 3</PackagingChargeCode>
<ManualPackagingChargeNatural>1</ManualPackagingChargeNatural>
</OrderCreationRequestShipmentPackage>
<OrderCreationRequestShipmentPackage>
<ReferenceId>1</ReferenceId>
<PackageTypeCode>sample string 4</PackageTypeCode>
<EstimatedWeightInPounds>1.1</EstimatedWeightInPounds>
<EstimatedHeightInInches>1.1</EstimatedHeightInInches>
<EstimatedWidthInInches>1.1</EstimatedWidthInInches>
<EstimatedLengthInInches>1.1</EstimatedLengthInInches>
<EstimatedDeclaredValue>1</EstimatedDeclaredValue>
<Description>sample string 1</Description>
<HandlingChargeCode>sample string 2</HandlingChargeCode>
<ManualHandlingChargeNatural>1</ManualHandlingChargeNatural>
<PackagingChargeCode>sample string 3</PackagingChargeCode>
<ManualPackagingChargeNatural>1</ManualPackagingChargeNatural>
</OrderCreationRequestShipmentPackage>
</Packages>
<DescriptionOverride>sample string 1</DescriptionOverride>
<TaxCode>sample string 2</TaxCode>
<ShipToEmail>sample string 3</ShipToEmail>
<ShipToAddressValidated>true</ShipToAddressValidated>
<ShipFromAddressOverride>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<Street3>sample string 3</Street3>
<City>sample string 4</City>
<Region>sample string 5</Region>
<Postalcode>sample string 6</Postalcode>
<PostalZip4>sample string 7</PostalZip4>
<CountryCode>sample string 8</CountryCode>
</ShipFromAddressOverride>
<ShipFromPhoneNumberOverride>sample string 4</ShipFromPhoneNumberOverride>
<ShipFromEmailOverride>sample string 5</ShipFromEmailOverride>
<ShipFromCompanyOverride>sample string 6</ShipFromCompanyOverride>
<UseCustomerAccountForShipping>true</UseCustomerAccountForShipping>
<CustomerShippingAccountCode>sample string 8</CustomerShippingAccountCode>
<Notifications>
<ShipmentEmailNotification>
<EmailAddress>sample string 1</EmailAddress>
<NotificationOption>None</NotificationOption>
</ShipmentEmailNotification>
<ShipmentEmailNotification>
<EmailAddress>sample string 1</EmailAddress>
<NotificationOption>None</NotificationOption>
</ShipmentEmailNotification>
</Notifications>
<CustomLabelDataHeader>sample string 9</CustomLabelDataHeader>
<CustomLabelDataValue>sample string 10</CustomLabelDataValue>
</OrderCreationRequestShipment>
</Shipments>
<Payments>
<OrderCreationPayment>
<ConfirmationNumber>sample string 1</ConfirmationNumber>
</OrderCreationPayment>
<OrderCreationPayment>
<ConfirmationNumber>sample string 1</ConfirmationNumber>
</OrderCreationPayment>
</Payments>
<NotifyShopOfNewOrder>true</NotifyShopOfNewOrder>
<AdditionalNotificationEmailAddresses>sample string 10</AdditionalNotificationEmailAddresses>
<CreateCodOrder>true</CreateCodOrder>
<OrderedByEmail>sample string 12</OrderedByEmail>
<OrderedByPhoneNumber>sample string 13</OrderedByPhoneNumber>
<OrderedByCompanyName>sample string 14</OrderedByCompanyName>
<CodAddress>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<City>sample string 3</City>
<Region>sample string 4</Region>
<Postalcode>sample string 5</Postalcode>
<CountryCode>sample string 6</CountryCode>
</CodAddress>
<OrderedByAddress>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<City>sample string 3</City>
<Region>sample string 4</Region>
<Postalcode>sample string 5</Postalcode>
<CountryCode>sample string 6</CountryCode>
</OrderedByAddress>
<OrderSource>Bpo</OrderSource>
<OverrideShippingProfileId>1</OverrideShippingProfileId>
</OrderCreationRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
An order estimation response containing pricing details of the estimated orders.
OrderEstimationResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyName |
The name of the company that the order was estimated for. |
string |
None. |
| PricingSheetName |
The name of the pricing sheet used to estimate the order. |
string |
None. |
| PricingSheetNumber |
The number of the pricing sheet used to estimate the order. |
string |
None. |
| LocationName |
The name of the company's location that the order was estimated for. |
string |
None. |
| AbcShopName |
The name of the ABC shop that would have responsibility for the order. |
string |
None. |
| Taxes |
The amount of all taxes associated with this order. |
decimal number |
None. |
| Total |
The total cost of this order. |
decimal number |
None. |
| CurrencyDescriptor |
The currency in which this order is priced. |
string |
None. |
| Lines |
The items that have been requested for this order. |
Collection of OrderEstimationResponseLine |
None. |
| TaxDetails |
A list of tax details for this order. |
Collection of OrderTaxDetail |
None. |
Response Formats
application/json, text/json
{
"CompanyName": "sample string 1",
"PricingSheetName": "sample string 2",
"PricingSheetNumber": "sample string 3",
"LocationName": "sample string 4",
"AbcShopName": "sample string 5",
"Taxes": 6.0,
"Total": 7.0,
"CurrencyDescriptor": "sample string 8",
"Lines": [
{
"Sequence": 1,
"ItemCode": "sample string 2",
"Description": "sample string 3",
"AbcShopName": "sample string 4",
"Originals": 5,
"Copies": 6,
"PriceSource": "sample string 7",
"UnitPrice": 8.0,
"UnitPriceIsVariable": true,
"ExtendedPrice": 10.0,
"IsShippingLine": true,
"PriceTierDetails": [
{
"Quantity": 1.0,
"Price": 2.0
},
{
"Quantity": 1.0,
"Price": 2.0
}
]
},
{
"Sequence": 1,
"ItemCode": "sample string 2",
"Description": "sample string 3",
"AbcShopName": "sample string 4",
"Originals": 5,
"Copies": 6,
"PriceSource": "sample string 7",
"UnitPrice": 8.0,
"UnitPriceIsVariable": true,
"ExtendedPrice": 10.0,
"IsShippingLine": true,
"PriceTierDetails": [
{
"Quantity": 1.0,
"Price": 2.0
},
{
"Quantity": 1.0,
"Price": 2.0
}
]
}
],
"TaxDetails": [
{
"TaxCode": "sample string 1",
"TaxRatePercent": 2.0,
"TaxableAmount": 3.0,
"TaxAmount": 4.0
},
{
"TaxCode": "sample string 1",
"TaxRatePercent": 2.0,
"TaxableAmount": 3.0,
"TaxAmount": 4.0
}
]
}
application/xml, text/xml
<OrderEstimationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CompanyName>sample string 1</CompanyName>
<PricingSheetName>sample string 2</PricingSheetName>
<PricingSheetNumber>sample string 3</PricingSheetNumber>
<LocationName>sample string 4</LocationName>
<AbcShopName>sample string 5</AbcShopName>
<Taxes>6</Taxes>
<Total>7</Total>
<CurrencyDescriptor>sample string 8</CurrencyDescriptor>
<Lines>
<OrderEstimationResponseLine>
<Sequence>1</Sequence>
<ItemCode>sample string 2</ItemCode>
<Description>sample string 3</Description>
<AbcShopName>sample string 4</AbcShopName>
<Originals>5</Originals>
<Copies>6</Copies>
<PriceSource>sample string 7</PriceSource>
<UnitPrice>8</UnitPrice>
<UnitPriceIsVariable>true</UnitPriceIsVariable>
<ExtendedPrice>10</ExtendedPrice>
<IsShippingLine>true</IsShippingLine>
<PriceTierDetails>
<OrderResponseLinePriceTierDetail>
<Quantity>1</Quantity>
<Price>2</Price>
</OrderResponseLinePriceTierDetail>
<OrderResponseLinePriceTierDetail>
<Quantity>1</Quantity>
<Price>2</Price>
</OrderResponseLinePriceTierDetail>
</PriceTierDetails>
</OrderEstimationResponseLine>
<OrderEstimationResponseLine>
<Sequence>1</Sequence>
<ItemCode>sample string 2</ItemCode>
<Description>sample string 3</Description>
<AbcShopName>sample string 4</AbcShopName>
<Originals>5</Originals>
<Copies>6</Copies>
<PriceSource>sample string 7</PriceSource>
<UnitPrice>8</UnitPrice>
<UnitPriceIsVariable>true</UnitPriceIsVariable>
<ExtendedPrice>10</ExtendedPrice>
<IsShippingLine>true</IsShippingLine>
<PriceTierDetails>
<OrderResponseLinePriceTierDetail>
<Quantity>1</Quantity>
<Price>2</Price>
</OrderResponseLinePriceTierDetail>
<OrderResponseLinePriceTierDetail>
<Quantity>1</Quantity>
<Price>2</Price>
</OrderResponseLinePriceTierDetail>
</PriceTierDetails>
</OrderEstimationResponseLine>
</Lines>
<TaxDetails>
<OrderTaxDetail>
<TaxCode>sample string 1</TaxCode>
<TaxRatePercent>2</TaxRatePercent>
<TaxableAmount>3</TaxableAmount>
<TaxAmount>4</TaxAmount>
</OrderTaxDetail>
<OrderTaxDetail>
<TaxCode>sample string 1</TaxCode>
<TaxRatePercent>2</TaxRatePercent>
<TaxableAmount>3</TaxableAmount>
<TaxAmount>4</TaxAmount>
</OrderTaxDetail>
</TaxDetails>
</OrderEstimationResponse>