POST api/orders
Create a new order. Successful requests will return either 201 Created or 202 Accepted.
Request Information
URI Parameters
None.
Body Parameters
An order creation request containing the order's details.
OrderCreationRequestName | 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. |
CodAddress |
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": "2024-12-25T08:53:48.1696442-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", "City": "sample string 3", "Region": "sample string 4", "Postalcode": "sample string 5", "PostalZip4": "sample string 6", "CountryCode": "sample string 7" }, "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 } ], "ShipmentReadyDateTimeLocal": "2024-12-25T08:53:48.1696442-05:00", "CustomerCloseTimeLocal": "2024-12-25T08:53:48.1696442-05:00", "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", "City": "sample string 3", "Region": "sample string 4", "Postalcode": "sample string 5", "PostalZip4": "sample string 6", "CountryCode": "sample string 7" }, "ShipToPhoneNumber": "sample string 14", "ShipToLocationId": 1, "ShipToAddressBookEntryId": 1, "ShipToIsResidential": true, "SaturdayDelivery": true, "SignatureRequired": true }, { "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", "City": "sample string 3", "Region": "sample string 4", "Postalcode": "sample string 5", "PostalZip4": "sample string 6", "CountryCode": "sample string 7" }, "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 } ], "ShipmentReadyDateTimeLocal": "2024-12-25T08:53:48.1696442-05:00", "CustomerCloseTimeLocal": "2024-12-25T08:53:48.1696442-05:00", "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", "City": "sample string 3", "Region": "sample string 4", "Postalcode": "sample string 5", "PostalZip4": "sample string 6", "CountryCode": "sample string 7" }, "ShipToPhoneNumber": "sample string 14", "ShipToLocationId": 1, "ShipToAddressBookEntryId": 1, "ShipToIsResidential": true, "SaturdayDelivery": true, "SignatureRequired": true } ], "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": "US" }, "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>2024-12-25T08:53:48.1696442-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> <City>sample string 3</City> <Region>sample string 4</Region> <Postalcode>sample string 5</Postalcode> <PostalZip4>sample string 6</PostalZip4> <CountryCode>sample string 7</CountryCode> </ShipToAddress> <ShipToPhoneNumber>sample string 14</ShipToPhoneNumber> <ShipToLocationId>1</ShipToLocationId> <ShipToAddressBookEntryId>1</ShipToAddressBookEntryId> <ShipToIsResidential>true</ShipToIsResidential> <SaturdayDelivery>true</SaturdayDelivery> <SignatureRequired>true</SignatureRequired> <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> <City>sample string 3</City> <Region>sample string 4</Region> <Postalcode>sample string 5</Postalcode> <PostalZip4>sample string 6</PostalZip4> <CountryCode>sample string 7</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> <ShipmentReadyDateTimeLocal>2024-12-25T08:53:48.1696442-05:00</ShipmentReadyDateTimeLocal> <CustomerCloseTimeLocal>2024-12-25T08:53:48.1696442-05:00</CustomerCloseTimeLocal> <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> <City>sample string 3</City> <Region>sample string 4</Region> <Postalcode>sample string 5</Postalcode> <PostalZip4>sample string 6</PostalZip4> <CountryCode>sample string 7</CountryCode> </ShipToAddress> <ShipToPhoneNumber>sample string 14</ShipToPhoneNumber> <ShipToLocationId>1</ShipToLocationId> <ShipToAddressBookEntryId>1</ShipToAddressBookEntryId> <ShipToIsResidential>true</ShipToIsResidential> <SaturdayDelivery>true</SaturdayDelivery> <SignatureRequired>true</SignatureRequired> <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> <City>sample string 3</City> <Region>sample string 4</Region> <Postalcode>sample string 5</Postalcode> <PostalZip4>sample string 6</PostalZip4> <CountryCode>sample string 7</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> <ShipmentReadyDateTimeLocal>2024-12-25T08:53:48.1696442-05:00</ShipmentReadyDateTimeLocal> <CustomerCloseTimeLocal>2024-12-25T08:53:48.1696442-05:00</CustomerCloseTimeLocal> <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> </CodAddress> <OrderSource>Bpo</OrderSource> <OverrideShippingProfileId>1</OverrideShippingProfileId> </OrderCreationRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
An order creation response containing the work order number of the newly created order.
OrderCreationResponseName | Description | Type | Additional information |
---|---|---|---|
OrderNumber |
The order number of the newly created order. |
integer |
None. |
NotificationsSent |
Indicates of the notifications were queued successfully. |
boolean |
None. |
Response Formats
application/json, text/json
{ "OrderNumber": 1, "NotificationsSent": true }
application/xml, text/xml
<OrderCreationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <OrderNumber>1</OrderNumber> <NotificationsSent>true</NotificationsSent> </OrderCreationResponse>