POST api/orders/{orderNumber}/updateShipment/{shipmentId}

Requests an update for a shipment on a work order.

Request Information

URI Parameters

Name	Description	Type	Additional information
orderNumber	Work order number	integer	Required
shipmentId	Shipment number	integer	Required

Body Parameters

Arguments describing how to update the delivery

OrderShipmentUpdateRequest

Name	Description	Type	Additional information
UpdateCustomerShippingAccount	Request that the customer's shipping account be updated	boolean	Default value is False
UseCustomerAccountForShipping	When shipping, should the customer's account be charged.	boolean	None.
CustomerShippingAccountCode	When charging the customer's account, code associated with the account to charge.	string	None.
UpdateShipToAttention	Request that the ship to attention be updated	boolean	Default value is False
ShipToAttention	The person who the shipment is shipped to.	string	None.
UpdateShipToAddress	Should the ship to address be updated	boolean	Default value is False
ShipToAddress	The address to ship to. (All fields will be updated)	Address	None.
ShipToAddressValidated	Has the address been successfully validated.	boolean	None.
UpdateShipToPhone	Should the ship to phone number be updated	boolean	Default value is False
ShipToPhone	The phone number of the recipient of the shipment.	string	None.
UpdateShipToEmail	Should the ship to email be updated	boolean	Default value is False
ShipToEmail	Email address of the recipient of the shipment.	string	None.
UpdateTaxCode	Should the Tax code for the shipment be updated	boolean	Default value is False
TaxCode	Indicates the sales tax code for the shipment based upon the destination.	string	None.
UpdateShipFromAddress	Should the ship from address be updated	boolean	Default value is False
ShipFromAddress	The address to ship from. (All fields will be updated)	Address	None.
PackageUpdateRequests	Represents requested updates to one or more packages on the shipment	Collection of OrderShipmentPackageUpdateRequest	None.
UpdateShipmentNotifications	Should the email notifications be updated.	boolean	Default value is False
ShipmentNotifications	The new list of notifications to update the shipment with. (All items will be updated/replaced).	Collection of ShipmentEmailNotification	None.
UpdateSignatureRequired	Should the signature required be updated	boolean	Default value is False
SignatureRequired	The new Signature Required value.	boolean	Default value is False
UpdateSaturdayDelivery	Should the signature required be updated	boolean	Default value is False
SaturdayDelivery	The new Signature Required value.	boolean	Default value is False
UpdateShipmentReadyDateTime	Should the shipment ready datetime be updated.	boolean	Default value is False
ShipmentReadyDateTimeLocal	If the shipper is to pick up the package, when will the shipment be ready. Time is local to the ship from location.	date	Default value is null
CustomerCloseTimeLocal	If the shipper is to pick up the package, what is the latest time the shipment will be accessible. Time is local to the ship from location. Defaults to 6:00 PM if not specified.	date	Default value is null
UpdateCustomLabelData	Should the Custom label data be updated.	boolean	Default value is False
CustomLabelDataHeader	An identifying header for custom label data. Defaults to "Note" when CustomLabelDataValue is specified;	string	String length: inclusive between 0 and 4
CustomLabelDataValue	Custom label data to be printed on the label.	string	String length: inclusive between 0 and 25

Request Formats

application/json, text/json

Sample:

{
  "UpdateCustomerShippingAccount": true,
  "UseCustomerAccountForShipping": true,
  "CustomerShippingAccountCode": "sample string 3",
  "UpdateShipToAttention": true,
  "ShipToAttention": "sample string 5",
  "UpdateShipToAddress": true,
  "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"
  },
  "ShipToAddressValidated": true,
  "UpdateShipToPhone": true,
  "ShipToPhone": "sample string 8",
  "UpdateShipToEmail": true,
  "ShipToEmail": "sample string 10",
  "UpdateTaxCode": true,
  "TaxCode": "sample string 12",
  "UpdateShipFromAddress": true,
  "ShipFromAddress": {
    "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"
  },
  "PackageUpdateRequests": [
    {
      "PackageId": 1,
      "UpdateHeight": true,
      "Height": 3.0,
      "UpdateWidth": true,
      "Width": 5.0,
      "UpdateLength": true,
      "Length": 7.0,
      "UpdateWeight": true,
      "Weight": 9.0,
      "UpdateDeclaredValue": true,
      "DeclaredValue": 1.0,
      "UpdateDescription": true,
      "Description": "sample string 12",
      "PackageContentUpdateRequests": [
        {
          "OrderLineId": 1,
          "CopyCount": 2
        },
        {
          "OrderLineId": 1,
          "CopyCount": 2
        }
      ]
    },
    {
      "PackageId": 1,
      "UpdateHeight": true,
      "Height": 3.0,
      "UpdateWidth": true,
      "Width": 5.0,
      "UpdateLength": true,
      "Length": 7.0,
      "UpdateWeight": true,
      "Weight": 9.0,
      "UpdateDeclaredValue": true,
      "DeclaredValue": 1.0,
      "UpdateDescription": true,
      "Description": "sample string 12",
      "PackageContentUpdateRequests": [
        {
          "OrderLineId": 1,
          "CopyCount": 2
        },
        {
          "OrderLineId": 1,
          "CopyCount": 2
        }
      ]
    }
  ],
  "UpdateShipmentNotifications": true,
  "ShipmentNotifications": [
    {
      "EmailAddress": "sample string 1",
      "NotificationOption": 0
    },
    {
      "EmailAddress": "sample string 1",
      "NotificationOption": 0
    }
  ],
  "UpdateSignatureRequired": true,
  "SignatureRequired": true,
  "UpdateSaturdayDelivery": true,
  "SaturdayDelivery": true,
  "UpdateShipmentReadyDateTime": true,
  "ShipmentReadyDateTimeLocal": "2025-12-01T08:31:03.4431522-05:00",
  "CustomerCloseTimeLocal": "2025-12-01T08:31:03.4431522-05:00",
  "UpdateCustomLabelData": true,
  "CustomLabelDataHeader": "sample string 21",
  "CustomLabelDataValue": "sample string 22"
}

application/xml, text/xml

Sample:

<OrderShipmentUpdateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <UpdateCustomerShippingAccount>true</UpdateCustomerShippingAccount>
  <UseCustomerAccountForShipping>true</UseCustomerAccountForShipping>
  <CustomerShippingAccountCode>sample string 3</CustomerShippingAccountCode>
  <UpdateShipToAttention>true</UpdateShipToAttention>
  <ShipToAttention>sample string 5</ShipToAttention>
  <UpdateShipToAddress>true</UpdateShipToAddress>
  <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>
  <ShipToAddressValidated>true</ShipToAddressValidated>
  <UpdateShipToPhone>true</UpdateShipToPhone>
  <ShipToPhone>sample string 8</ShipToPhone>
  <UpdateShipToEmail>true</UpdateShipToEmail>
  <ShipToEmail>sample string 10</ShipToEmail>
  <UpdateTaxCode>true</UpdateTaxCode>
  <TaxCode>sample string 12</TaxCode>
  <UpdateShipFromAddress>true</UpdateShipFromAddress>
  <ShipFromAddress>
    <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>
  </ShipFromAddress>
  <PackageUpdateRequests>
    <OrderShipmentPackageUpdateRequest>
      <PackageId>1</PackageId>
      <UpdateHeight>true</UpdateHeight>
      <Height>3</Height>
      <UpdateWidth>true</UpdateWidth>
      <Width>5</Width>
      <UpdateLength>true</UpdateLength>
      <Length>7</Length>
      <UpdateWeight>true</UpdateWeight>
      <Weight>9</Weight>
      <UpdateDeclaredValue>true</UpdateDeclaredValue>
      <DeclaredValue>1</DeclaredValue>
      <UpdateDescription>true</UpdateDescription>
      <Description>sample string 12</Description>
      <PackageContentUpdateRequests>
        <OrderShipmentPackageContentUpdateRequest>
          <OrderLineId>1</OrderLineId>
          <CopyCount>2</CopyCount>
        </OrderShipmentPackageContentUpdateRequest>
        <OrderShipmentPackageContentUpdateRequest>
          <OrderLineId>1</OrderLineId>
          <CopyCount>2</CopyCount>
        </OrderShipmentPackageContentUpdateRequest>
      </PackageContentUpdateRequests>
    </OrderShipmentPackageUpdateRequest>
    <OrderShipmentPackageUpdateRequest>
      <PackageId>1</PackageId>
      <UpdateHeight>true</UpdateHeight>
      <Height>3</Height>
      <UpdateWidth>true</UpdateWidth>
      <Width>5</Width>
      <UpdateLength>true</UpdateLength>
      <Length>7</Length>
      <UpdateWeight>true</UpdateWeight>
      <Weight>9</Weight>
      <UpdateDeclaredValue>true</UpdateDeclaredValue>
      <DeclaredValue>1</DeclaredValue>
      <UpdateDescription>true</UpdateDescription>
      <Description>sample string 12</Description>
      <PackageContentUpdateRequests>
        <OrderShipmentPackageContentUpdateRequest>
          <OrderLineId>1</OrderLineId>
          <CopyCount>2</CopyCount>
        </OrderShipmentPackageContentUpdateRequest>
        <OrderShipmentPackageContentUpdateRequest>
          <OrderLineId>1</OrderLineId>
          <CopyCount>2</CopyCount>
        </OrderShipmentPackageContentUpdateRequest>
      </PackageContentUpdateRequests>
    </OrderShipmentPackageUpdateRequest>
  </PackageUpdateRequests>
  <UpdateShipmentNotifications>true</UpdateShipmentNotifications>
  <ShipmentNotifications>
    <ShipmentEmailNotification>
      <EmailAddress>sample string 1</EmailAddress>
      <NotificationOption>None</NotificationOption>
    </ShipmentEmailNotification>
    <ShipmentEmailNotification>
      <EmailAddress>sample string 1</EmailAddress>
      <NotificationOption>None</NotificationOption>
    </ShipmentEmailNotification>
  </ShipmentNotifications>
  <UpdateSignatureRequired>true</UpdateSignatureRequired>
  <SignatureRequired>true</SignatureRequired>
  <UpdateSaturdayDelivery>true</UpdateSaturdayDelivery>
  <SaturdayDelivery>true</SaturdayDelivery>
  <UpdateShipmentReadyDateTime>true</UpdateShipmentReadyDateTime>
  <ShipmentReadyDateTimeLocal>2025-12-01T08:31:03.4431522-05:00</ShipmentReadyDateTimeLocal>
  <CustomerCloseTimeLocal>2025-12-01T08:31:03.4431522-05:00</CustomerCloseTimeLocal>
  <UpdateCustomLabelData>true</UpdateCustomLabelData>
  <CustomLabelDataHeader>sample string 21</CustomLabelDataHeader>
  <CustomLabelDataValue>sample string 22</CustomLabelDataValue>
</OrderShipmentUpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A representation of a single order.

OrderDetailResponse

Name	Description	Type	Additional information
CompanyName	The name of the company that placed the order.	string	None.
BillToCompanyId	The identifying number for the company that the order is billed to.	integer	None.
PricingSheetName	The name of the pricing sheet used on the order.	string	None.
PricingSheetNumber	The number of the pricing sheet used on the order.	string	None.
LocationName	The name of the company's location that the order was placed for.	string	None.
AbcShopName	The name of the ABC shop that has responsibility for the order.	string	None.
AbcShop	Details of the ABC Shop location.	Location	None.
OrderNumber	The order number of the requested order.	integer	None.
LastModifiedBy	Who last modified the requested order.	string	None.
LastModified	When was the requested order last modified.	date	None.
Comment	An order comment.	string	None.
PrintCommentOnWorkOrder	Is the comment printed on the order.	boolean	None.
Comment2	A secondary order comment.	string	None.
PrintComment2OnWorkOrder	Is the second order comment printed on the order.	boolean	None.
PurchaseOrderNumber	The purchase order number referenced this this order.	string	None.
ProjectNumber	The project number reference by this order.	string	None.
ProjectName	The project name referenced by this order.	string	None.
DueDateTime	The date and time the order is due.	date	None.
EnteredDate	The date and time the order was entered.	date	None.
RequestDate	The date and time the order was requested.	date	None.
OrderedBy	Who actually placed the order.	string	None.
OrderStatus	The status of the order.	OrderStatus	None.
ProductionStatus	The production status of the order.	OrderProductionStatus	None.
Taxes	The amount of all taxes associated with this order.	decimal number	None.
Total	The total cost of this order.	decimal number	None.
Payments	The total amount of payments applied to the 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 OrderDetailResponseLine	None.
Attachments	A list of files attached to this order.	Collection of OrderDetailResponseAttachment	None.
Shipments	A list of shipments on this order.	Collection of OrderDetailResponseShipment	None.
TaxDetails	A list of tax details for this order.	Collection of OrderTaxDetail	None.
CancellationComments	Comments on a cancelled order.	Collection of DatedCommentDetail	None.
OrderedByEmail	Email of the person that placed the order.	string	None.
OrderedByPhoneNumber	Phone number of the person that placed the order.	string	None.
OrderedByCompanyName	Company that placed the order	string	None.
OrderedByAddress	Address of the company that placed the order	Address	None.
IsEstimate	Is the order marked as an estimate.	boolean	None.
IsEstimateFinalized	Has the estimation process been completed.	boolean	None.
BillingMethod	How is the order to be billed	OrderBillingMethod	None.
OnAccountPaymentAvailable	Is OnAccount available for the estimate	boolean	None.
BillToCustomerCode	The customer code of the company that would be used to validate project changes.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "BillToCompanyId": 2,
  "PricingSheetName": "sample string 3",
  "PricingSheetNumber": "sample string 4",
  "LocationName": "sample string 5",
  "AbcShopName": "sample string 6",
  "AbcShop": {
    "LocationId": 1,
    "ShortName": "sample string 2",
    "Name": "sample string 3",
    "Code": "sample string 4",
    "BillingAddress": {
      "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"
    },
    "ShippingAddress": {
      "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"
    },
    "LocationType": 0,
    "Email": "sample string 5",
    "Phone": "sample string 6",
    "CodCustomerId": 1
  },
  "OrderNumber": 7,
  "LastModifiedBy": "sample string 8",
  "LastModified": "2025-12-01T08:31:03.4587746-05:00",
  "Comment": "sample string 10",
  "PrintCommentOnWorkOrder": true,
  "Comment2": "sample string 12",
  "PrintComment2OnWorkOrder": true,
  "PurchaseOrderNumber": "sample string 14",
  "ProjectNumber": "sample string 15",
  "ProjectName": "sample string 16",
  "DueDateTime": "2025-12-01T08:31:03.4587746-05:00",
  "EnteredDate": "2025-12-01T08:31:03.4587746-05:00",
  "RequestDate": "2025-12-01T08:31:03.4587746-05:00",
  "OrderedBy": "sample string 20",
  "OrderStatus": 0,
  "ProductionStatus": 0,
  "Taxes": 21.0,
  "Total": 22.0,
  "Payments": 23.0,
  "CurrencyDescriptor": "sample string 24",
  "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,
      "AdditionalDetails": "sample string 11",
      "IsShippingLine": true,
      "ShipmentAllocations": [
        {
          "ShipmentId": 1,
          "PackageId": 1,
          "CopyCount": 2
        },
        {
          "ShipmentId": 1,
          "PackageId": 1,
          "CopyCount": 2
        }
      ],
      "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,
      "AdditionalDetails": "sample string 11",
      "IsShippingLine": true,
      "ShipmentAllocations": [
        {
          "ShipmentId": 1,
          "PackageId": 1,
          "CopyCount": 2
        },
        {
          "ShipmentId": 1,
          "PackageId": 1,
          "CopyCount": 2
        }
      ],
      "PriceTierDetails": [
        {
          "Quantity": 1.0,
          "Price": 2.0
        },
        {
          "Quantity": 1.0,
          "Price": 2.0
        }
      ]
    }
  ],
  "Attachments": [
    {
      "AttachmentOriginalFileName": "sample string 1",
      "AttachmentName": "sample string 2",
      "AttachmentType": 21,
      "AttachmentIdentifier": "97c2e257-2b8a-4442-a27d-1d975e51b02f",
      "AttachmentDescription": "sample string 4"
    },
    {
      "AttachmentOriginalFileName": "sample string 1",
      "AttachmentName": "sample string 2",
      "AttachmentType": 21,
      "AttachmentIdentifier": "97c2e257-2b8a-4442-a27d-1d975e51b02f",
      "AttachmentDescription": "sample string 4"
    }
  ],
  "Shipments": [
    {
      "ShipmentId": 1,
      "ShippingMethod": 1,
      "ShipmentType": 0,
      "ShippingServiceCode": "sample string 2",
      "ShippingServiceDescription": "sample string 3",
      "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"
      },
      "ShipToCompany": "sample string 4",
      "ShipToEmail": "sample string 5",
      "ShipToAttention": "sample string 6",
      "ShipToPhone": "sample string 7",
      "Description": "sample string 8",
      "Status": 0,
      "SignatureRequired": true,
      "SaturdayDelivery": true,
      "ShipmentReadyDateTimeLocal": "2025-12-01T08:31:03.4587746-05:00",
      "CustomerCloseTimeLocal": "2025-12-01T08:31:03.4587746-05:00",
      "CustomLabelDataHeader": "sample string 11",
      "CustomLabelDataValue": "sample string 12",
      "Packages": [
        {
          "PackageId": 1,
          "Description": "sample string 2",
          "PackageTypeCode": "sample string 3",
          "PackageTypeDescription": "sample string 4",
          "LengthInInches": 5.0,
          "WidthInInches": 6.0,
          "HeightInInches": 7.0,
          "DeclaredValue": 1.0,
          "WeightInPounds": 8.0,
          "TrackingNumber": "sample string 9",
          "ApiReferenceNo": 1
        },
        {
          "PackageId": 1,
          "Description": "sample string 2",
          "PackageTypeCode": "sample string 3",
          "PackageTypeDescription": "sample string 4",
          "LengthInInches": 5.0,
          "WidthInInches": 6.0,
          "HeightInInches": 7.0,
          "DeclaredValue": 1.0,
          "WeightInPounds": 8.0,
          "TrackingNumber": "sample string 9",
          "ApiReferenceNo": 1
        }
      ],
      "Notifications": [
        {
          "EmailAddress": "sample string 1",
          "NotificationOption": 0
        },
        {
          "EmailAddress": "sample string 1",
          "NotificationOption": 0
        }
      ]
    },
    {
      "ShipmentId": 1,
      "ShippingMethod": 1,
      "ShipmentType": 0,
      "ShippingServiceCode": "sample string 2",
      "ShippingServiceDescription": "sample string 3",
      "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"
      },
      "ShipToCompany": "sample string 4",
      "ShipToEmail": "sample string 5",
      "ShipToAttention": "sample string 6",
      "ShipToPhone": "sample string 7",
      "Description": "sample string 8",
      "Status": 0,
      "SignatureRequired": true,
      "SaturdayDelivery": true,
      "ShipmentReadyDateTimeLocal": "2025-12-01T08:31:03.4587746-05:00",
      "CustomerCloseTimeLocal": "2025-12-01T08:31:03.4587746-05:00",
      "CustomLabelDataHeader": "sample string 11",
      "CustomLabelDataValue": "sample string 12",
      "Packages": [
        {
          "PackageId": 1,
          "Description": "sample string 2",
          "PackageTypeCode": "sample string 3",
          "PackageTypeDescription": "sample string 4",
          "LengthInInches": 5.0,
          "WidthInInches": 6.0,
          "HeightInInches": 7.0,
          "DeclaredValue": 1.0,
          "WeightInPounds": 8.0,
          "TrackingNumber": "sample string 9",
          "ApiReferenceNo": 1
        },
        {
          "PackageId": 1,
          "Description": "sample string 2",
          "PackageTypeCode": "sample string 3",
          "PackageTypeDescription": "sample string 4",
          "LengthInInches": 5.0,
          "WidthInInches": 6.0,
          "HeightInInches": 7.0,
          "DeclaredValue": 1.0,
          "WeightInPounds": 8.0,
          "TrackingNumber": "sample string 9",
          "ApiReferenceNo": 1
        }
      ],
      "Notifications": [
        {
          "EmailAddress": "sample string 1",
          "NotificationOption": 0
        },
        {
          "EmailAddress": "sample string 1",
          "NotificationOption": 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
    }
  ],
  "CancellationComments": [
    {
      "EnteredDate": "2025-12-01T08:31:03.4587746-05:00",
      "Comment": "sample string 2"
    },
    {
      "EnteredDate": "2025-12-01T08:31:03.4587746-05:00",
      "Comment": "sample string 2"
    }
  ],
  "OrderedByEmail": "sample string 25",
  "OrderedByPhoneNumber": "sample string 26",
  "OrderedByCompanyName": "sample string 27",
  "OrderedByAddress": {
    "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"
  },
  "IsEstimate": true,
  "IsEstimateFinalized": true,
  "BillingMethod": 0,
  "OnAccountPaymentAvailable": true,
  "BillToCustomerCode": "sample string 31"
}

application/xml, text/xml

Sample:

<OrderDetailResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CompanyName>sample string 1</CompanyName>
  <BillToCompanyId>2</BillToCompanyId>
  <PricingSheetName>sample string 3</PricingSheetName>
  <PricingSheetNumber>sample string 4</PricingSheetNumber>
  <LocationName>sample string 5</LocationName>
  <AbcShopName>sample string 6</AbcShopName>
  <AbcShop>
    <LocationId>1</LocationId>
    <ShortName>sample string 2</ShortName>
    <Name>sample string 3</Name>
    <Code>sample string 4</Code>
    <BillingAddress>
      <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>
    </BillingAddress>
    <ShippingAddress>
      <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>
    </ShippingAddress>
    <LocationType>Customer</LocationType>
    <Email>sample string 5</Email>
    <Phone>sample string 6</Phone>
    <CodCustomerId>1</CodCustomerId>
  </AbcShop>
  <OrderNumber>7</OrderNumber>
  <LastModifiedBy>sample string 8</LastModifiedBy>
  <LastModified>2025-12-01T08:31:03.4587746-05:00</LastModified>
  <Comment>sample string 10</Comment>
  <PrintCommentOnWorkOrder>true</PrintCommentOnWorkOrder>
  <Comment2>sample string 12</Comment2>
  <PrintComment2OnWorkOrder>true</PrintComment2OnWorkOrder>
  <PurchaseOrderNumber>sample string 14</PurchaseOrderNumber>
  <ProjectNumber>sample string 15</ProjectNumber>
  <ProjectName>sample string 16</ProjectName>
  <DueDateTime>2025-12-01T08:31:03.4587746-05:00</DueDateTime>
  <EnteredDate>2025-12-01T08:31:03.4587746-05:00</EnteredDate>
  <RequestDate>2025-12-01T08:31:03.4587746-05:00</RequestDate>
  <OrderedBy>sample string 20</OrderedBy>
  <OrderStatus>Cancelled</OrderStatus>
  <ProductionStatus>Active</ProductionStatus>
  <Taxes>21</Taxes>
  <Total>22</Total>
  <Payments>23</Payments>
  <CurrencyDescriptor>sample string 24</CurrencyDescriptor>
  <Lines>
    <OrderDetailResponseLine>
      <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>
      <AdditionalDetails>sample string 11</AdditionalDetails>
      <IsShippingLine>true</IsShippingLine>
      <ShipmentAllocations>
        <OrderDetailResponseLineAllocation>
          <ShipmentId>1</ShipmentId>
          <PackageId>1</PackageId>
          <CopyCount>2</CopyCount>
        </OrderDetailResponseLineAllocation>
        <OrderDetailResponseLineAllocation>
          <ShipmentId>1</ShipmentId>
          <PackageId>1</PackageId>
          <CopyCount>2</CopyCount>
        </OrderDetailResponseLineAllocation>
      </ShipmentAllocations>
      <PriceTierDetails>
        <OrderResponseLinePriceTierDetail>
          <Quantity>1</Quantity>
          <Price>2</Price>
        </OrderResponseLinePriceTierDetail>
        <OrderResponseLinePriceTierDetail>
          <Quantity>1</Quantity>
          <Price>2</Price>
        </OrderResponseLinePriceTierDetail>
      </PriceTierDetails>
    </OrderDetailResponseLine>
    <OrderDetailResponseLine>
      <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>
      <AdditionalDetails>sample string 11</AdditionalDetails>
      <IsShippingLine>true</IsShippingLine>
      <ShipmentAllocations>
        <OrderDetailResponseLineAllocation>
          <ShipmentId>1</ShipmentId>
          <PackageId>1</PackageId>
          <CopyCount>2</CopyCount>
        </OrderDetailResponseLineAllocation>
        <OrderDetailResponseLineAllocation>
          <ShipmentId>1</ShipmentId>
          <PackageId>1</PackageId>
          <CopyCount>2</CopyCount>
        </OrderDetailResponseLineAllocation>
      </ShipmentAllocations>
      <PriceTierDetails>
        <OrderResponseLinePriceTierDetail>
          <Quantity>1</Quantity>
          <Price>2</Price>
        </OrderResponseLinePriceTierDetail>
        <OrderResponseLinePriceTierDetail>
          <Quantity>1</Quantity>
          <Price>2</Price>
        </OrderResponseLinePriceTierDetail>
      </PriceTierDetails>
    </OrderDetailResponseLine>
  </Lines>
  <Attachments>
    <OrderDetailResponseAttachment>
      <AttachmentOriginalFileName>sample string 1</AttachmentOriginalFileName>
      <AttachmentName>sample string 2</AttachmentName>
      <AttachmentType>DeliveryInstructions</AttachmentType>
      <AttachmentIdentifier>97c2e257-2b8a-4442-a27d-1d975e51b02f</AttachmentIdentifier>
      <AttachmentDescription>sample string 4</AttachmentDescription>
    </OrderDetailResponseAttachment>
    <OrderDetailResponseAttachment>
      <AttachmentOriginalFileName>sample string 1</AttachmentOriginalFileName>
      <AttachmentName>sample string 2</AttachmentName>
      <AttachmentType>DeliveryInstructions</AttachmentType>
      <AttachmentIdentifier>97c2e257-2b8a-4442-a27d-1d975e51b02f</AttachmentIdentifier>
      <AttachmentDescription>sample string 4</AttachmentDescription>
    </OrderDetailResponseAttachment>
  </Attachments>
  <Shipments>
    <OrderDetailResponseShipment>
      <ShipmentId>1</ShipmentId>
      <ShippingMethod>Ups</ShippingMethod>
      <ShipmentType>Normal</ShipmentType>
      <ShippingServiceCode>sample string 2</ShippingServiceCode>
      <ShippingServiceDescription>sample string 3</ShippingServiceDescription>
      <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>
      <ShipToCompany>sample string 4</ShipToCompany>
      <ShipToEmail>sample string 5</ShipToEmail>
      <ShipToAttention>sample string 6</ShipToAttention>
      <ShipToPhone>sample string 7</ShipToPhone>
      <Description>sample string 8</Description>
      <Status>Draft</Status>
      <SignatureRequired>true</SignatureRequired>
      <SaturdayDelivery>true</SaturdayDelivery>
      <ShipmentReadyDateTimeLocal>2025-12-01T08:31:03.4587746-05:00</ShipmentReadyDateTimeLocal>
      <CustomerCloseTimeLocal>2025-12-01T08:31:03.4587746-05:00</CustomerCloseTimeLocal>
      <CustomLabelDataHeader>sample string 11</CustomLabelDataHeader>
      <CustomLabelDataValue>sample string 12</CustomLabelDataValue>
      <Packages>
        <OrderDetailResponseShipmentPackage>
          <PackageId>1</PackageId>
          <Description>sample string 2</Description>
          <PackageTypeCode>sample string 3</PackageTypeCode>
          <PackageTypeDescription>sample string 4</PackageTypeDescription>
          <LengthInInches>5</LengthInInches>
          <WidthInInches>6</WidthInInches>
          <HeightInInches>7</HeightInInches>
          <DeclaredValue>1</DeclaredValue>
          <WeightInPounds>8</WeightInPounds>
          <TrackingNumber>sample string 9</TrackingNumber>
          <ApiReferenceNo>1</ApiReferenceNo>
        </OrderDetailResponseShipmentPackage>
        <OrderDetailResponseShipmentPackage>
          <PackageId>1</PackageId>
          <Description>sample string 2</Description>
          <PackageTypeCode>sample string 3</PackageTypeCode>
          <PackageTypeDescription>sample string 4</PackageTypeDescription>
          <LengthInInches>5</LengthInInches>
          <WidthInInches>6</WidthInInches>
          <HeightInInches>7</HeightInInches>
          <DeclaredValue>1</DeclaredValue>
          <WeightInPounds>8</WeightInPounds>
          <TrackingNumber>sample string 9</TrackingNumber>
          <ApiReferenceNo>1</ApiReferenceNo>
        </OrderDetailResponseShipmentPackage>
      </Packages>
      <Notifications>
        <ShipmentEmailNotification>
          <EmailAddress>sample string 1</EmailAddress>
          <NotificationOption>None</NotificationOption>
        </ShipmentEmailNotification>
        <ShipmentEmailNotification>
          <EmailAddress>sample string 1</EmailAddress>
          <NotificationOption>None</NotificationOption>
        </ShipmentEmailNotification>
      </Notifications>
    </OrderDetailResponseShipment>
    <OrderDetailResponseShipment>
      <ShipmentId>1</ShipmentId>
      <ShippingMethod>Ups</ShippingMethod>
      <ShipmentType>Normal</ShipmentType>
      <ShippingServiceCode>sample string 2</ShippingServiceCode>
      <ShippingServiceDescription>sample string 3</ShippingServiceDescription>
      <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>
      <ShipToCompany>sample string 4</ShipToCompany>
      <ShipToEmail>sample string 5</ShipToEmail>
      <ShipToAttention>sample string 6</ShipToAttention>
      <ShipToPhone>sample string 7</ShipToPhone>
      <Description>sample string 8</Description>
      <Status>Draft</Status>
      <SignatureRequired>true</SignatureRequired>
      <SaturdayDelivery>true</SaturdayDelivery>
      <ShipmentReadyDateTimeLocal>2025-12-01T08:31:03.4587746-05:00</ShipmentReadyDateTimeLocal>
      <CustomerCloseTimeLocal>2025-12-01T08:31:03.4587746-05:00</CustomerCloseTimeLocal>
      <CustomLabelDataHeader>sample string 11</CustomLabelDataHeader>
      <CustomLabelDataValue>sample string 12</CustomLabelDataValue>
      <Packages>
        <OrderDetailResponseShipmentPackage>
          <PackageId>1</PackageId>
          <Description>sample string 2</Description>
          <PackageTypeCode>sample string 3</PackageTypeCode>
          <PackageTypeDescription>sample string 4</PackageTypeDescription>
          <LengthInInches>5</LengthInInches>
          <WidthInInches>6</WidthInInches>
          <HeightInInches>7</HeightInInches>
          <DeclaredValue>1</DeclaredValue>
          <WeightInPounds>8</WeightInPounds>
          <TrackingNumber>sample string 9</TrackingNumber>
          <ApiReferenceNo>1</ApiReferenceNo>
        </OrderDetailResponseShipmentPackage>
        <OrderDetailResponseShipmentPackage>
          <PackageId>1</PackageId>
          <Description>sample string 2</Description>
          <PackageTypeCode>sample string 3</PackageTypeCode>
          <PackageTypeDescription>sample string 4</PackageTypeDescription>
          <LengthInInches>5</LengthInInches>
          <WidthInInches>6</WidthInInches>
          <HeightInInches>7</HeightInInches>
          <DeclaredValue>1</DeclaredValue>
          <WeightInPounds>8</WeightInPounds>
          <TrackingNumber>sample string 9</TrackingNumber>
          <ApiReferenceNo>1</ApiReferenceNo>
        </OrderDetailResponseShipmentPackage>
      </Packages>
      <Notifications>
        <ShipmentEmailNotification>
          <EmailAddress>sample string 1</EmailAddress>
          <NotificationOption>None</NotificationOption>
        </ShipmentEmailNotification>
        <ShipmentEmailNotification>
          <EmailAddress>sample string 1</EmailAddress>
          <NotificationOption>None</NotificationOption>
        </ShipmentEmailNotification>
      </Notifications>
    </OrderDetailResponseShipment>
  </Shipments>
  <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>
  <CancellationComments>
    <DatedCommentDetail>
      <EnteredDate>2025-12-01T08:31:03.4587746-05:00</EnteredDate>
      <Comment>sample string 2</Comment>
    </DatedCommentDetail>
    <DatedCommentDetail>
      <EnteredDate>2025-12-01T08:31:03.4587746-05:00</EnteredDate>
      <Comment>sample string 2</Comment>
    </DatedCommentDetail>
  </CancellationComments>
  <OrderedByEmail>sample string 25</OrderedByEmail>
  <OrderedByPhoneNumber>sample string 26</OrderedByPhoneNumber>
  <OrderedByCompanyName>sample string 27</OrderedByCompanyName>
  <OrderedByAddress>
    <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>
  </OrderedByAddress>
  <IsEstimate>true</IsEstimate>
  <IsEstimateFinalized>true</IsEstimateFinalized>
  <BillingMethod>Account</BillingMethod>
  <OnAccountPaymentAvailable>true</OnAccountPaymentAvailable>
  <BillToCustomerCode>sample string 31</BillToCustomerCode>
</OrderDetailResponse>