PUT api/OrderDatas/{id}

Edits an order, including order status and order item details.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id is the int OrderId in the BGS system, and must be supplied both in this URI id paramater and in the OrderId Body parameter.	integer	Required

Body Parameters

Please note that any null value submitted will be ignored. If you would like to remove a value, please enter an empty string "" and it will be converted to a null value.

OrderEditData

Name	Description	Type	Additional information
OrderId	Unique identifier from the BGS system that is assigned at order creation. This value must be supplied both as the URI id paramater and in this OrderId Body parameter.	integer	Required
ClientOrderId	Unique order identifier from your system.	string	String length: inclusive between 1 and 100
ClientOrderId2	Alternate order identifier from your system. For example, a PO number. Does not need to be unique.	string	None.
WarehouseCode	Use "MEM" to send the order to the Memphis warehouse. Use "SLC" to send the order to the Salt Lake City warehouse.	string	None.
OrderStatus	Acceptable values are: Back Order, Cancelled, Created, Editing, Imported, Modified, On Hold, Released Back Order, Reset	string	None.
OrderDate		date	None.
ShipByDate		date	None.
DeliverByDate		date	None.
CompanyOrName		string	String length: inclusive between 2 and 35
Attention		string	String length: inclusive between 2 and 35
AddressLine1		string	String length: inclusive between 2 and 35
AddressLine2		string	String length: inclusive between 2 and 35
AddressLine3		string	String length: inclusive between 2 and 35
City		string	String length: inclusive between 2 and 35
State	Can accept the 2 digit state code or the state's full name.	string	String length: inclusive between 2 and 35
PostalCode		string	String length: inclusive between 2 and 35
Country	Can accept the 2 digit ISO code, the 3 digit ISO code, or the country's full name.	string	String length: inclusive between 2 and 35
Phone		string	String length: inclusive between 0 and 35
Email		string	String length: inclusive between 0 and 100
ShippingMethod	Acceptable values are: 3RDP_LTL, AAAC_LTL, ABFS_LTL, AVRT_LTL, Bestway_LTL, BGS_Freight, BGS_WillCall, CENT_LTL, DAFG_LTL, DHL_ExpressWorldwide, E2OP_LTL, ECHO_LTL, ECHO_LTL_EXPEDITED, EXLA_LTL, FEDEX_1DayFreight, FEDEX_2DayFreight, FEDEX_3DayFreight, FEDEX_ASRStandardOvernight, FEDEX_ASR2Day, FEDEX_ASRExpressSaver3Day, FEDEX_ASRGround, FEDEX_FirstOvernightFreight, FEDEX_FirstOvernight, FEDEX_PriorityOvernight, FEDEX_StandardOvernight, FEDEX_StandardOvernight_Saturday, FEDEX_2DayAM, FEDEX_2Day, FEDEX_ExpressSaver, FEDEX_GroundDelivery, FEDEX_Ground3rdParty, FEDEX_HomeDelivery, FWRD_LTL, GDN_International, HMES_LTL, NVX_Freight, NVX_WillCall, NVX_CustomerCollectAPiWater, NVX_NavispherePoolcorp, NVX_UTSAPiWater, NVX_APiFedEx, ODFL_LTL, RDWY_LTL, RLC_LTL, SAIA_LTL, SEFL_LTL, TAZ_LTL, UPGF_LTL, UPS_ASROvernightSaver, UPS_ASR2Day, UPS_ASR3Day, UPS_ASRGround, UPS_2ndDayAir, UPS_2ndDayAirAM, UPS_3DaySelect, UPS_Ground, UPS_GroundCommercial, UPS_GroundResidential, UPS_Ground3rdParty, UPS_Freight, UPS_MailInnovations, UPS_NextDayAir, UPS_NextDayAir_Saturday, UPS_NextDayAirEarlyAM, UPS_NextDayAirSaver, UPS_StandardtoCanada, UPS_SurePost, UPS_WorldwideExpedited, UPS_WorldwideExpress, USPS_FirstClass, USPS_FirstClassInternational, USPS_PriorityMail, USPS_PriorityMailASR, USPS_PriorityMailExpress, USPS_PriorityMailExpressInternational, USPS_PriorityMailInternational, and XPOL_LTL	string	None.
NotesToCustomerPackingSlip	Text submitted here will appear on the packing slip to the end customer.	string	String length: inclusive between 0 and 500
NotesToWarehouse	Text submitted here will appear on screen when picking an order.	string	String length: inclusive between 0 and 255
OrderDetailEditData	When the OrderDetailEditData is supplied, then ALL the existing order detail contents will be deleted and replaced with the new contents submitted in this OrderDetailEditData.	Collection of OrderDetailEditData	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": 2,
  "ClientOrderId": "sample string 3",
  "ClientOrderId2": "sample string 4",
  "WarehouseCode": "sample string 5",
  "OrderStatus": "sample string 6",
  "OrderDate": "2025-12-14T15:23:34.8420934+00:00",
  "ShipByDate": "2025-12-14T15:23:34.8420934+00:00",
  "DeliverByDate": "2025-12-14T15:23:34.8420934+00:00",
  "CompanyOrName": "sample string 7",
  "Attention": "sample string 8",
  "AddressLine1": "sample string 9",
  "AddressLine2": "sample string 10",
  "AddressLine3": "sample string 11",
  "City": "sample string 12",
  "State": "sample string 13",
  "PostalCode": "sample string 14",
  "Country": "sample string 15",
  "Phone": "sample string 16",
  "Email": "sample string 17",
  "ShippingMethod": "sample string 19",
  "NotesToCustomerPackingSlip": "sample string 20",
  "NotesToWarehouse": "sample string 21",
  "OrderDetailEditData": [
    {
      "ItemSKU": "sample string 2",
      "ItemQuantity": 3
    },
    {
      "ItemSKU": "sample string 2",
      "ItemQuantity": 3
    }
  ]
}

application/xml, text/xml

Sample:

<OrderEditData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCBGSAPI.Models">
  <AddressLine1>sample string 9</AddressLine1>
  <AddressLine2>sample string 10</AddressLine2>
  <AddressLine3>sample string 11</AddressLine3>
  <Attention>sample string 8</Attention>
  <CarrierCode>sample string 18</CarrierCode>
  <City>sample string 12</City>
  <ClientOrderId>sample string 3</ClientOrderId>
  <ClientOrderId2>sample string 4</ClientOrderId2>
  <CompanyOrName>sample string 7</CompanyOrName>
  <Country>sample string 15</Country>
  <DeliverByDate>2025-12-14T15:23:34.8420934+00:00</DeliverByDate>
  <Email>sample string 17</Email>
  <NotesToCustomerPackingSlip>sample string 20</NotesToCustomerPackingSlip>
  <NotesToWarehouse>sample string 21</NotesToWarehouse>
  <OrderDate>2025-12-14T15:23:34.8420934+00:00</OrderDate>
  <OrderDetailEditData>
    <OrderDetailEditData>
      <ItemQuantity>3</ItemQuantity>
      <ItemSKU>sample string 2</ItemSKU>
      <OrderDetailEditDataId>1</OrderDetailEditDataId>
    </OrderDetailEditData>
    <OrderDetailEditData>
      <ItemQuantity>3</ItemQuantity>
      <ItemSKU>sample string 2</ItemSKU>
      <OrderDetailEditDataId>1</OrderDetailEditDataId>
    </OrderDetailEditData>
  </OrderDetailEditData>
  <OrderEditDataId>1</OrderEditDataId>
  <OrderId>2</OrderId>
  <OrderStatus>sample string 6</OrderStatus>
  <Phone>sample string 16</Phone>
  <PostalCode>sample string 14</PostalCode>
  <ShipByDate>2025-12-14T15:23:34.8420934+00:00</ShipByDate>
  <ShippingMethod>sample string 19</ShippingMethod>
  <State>sample string 13</State>
  <WarehouseCode>sample string 5</WarehouseCode>
</OrderEditData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderData

Name	Description	Type	Additional information
OrderId	Unique identifier from the BGS system that is assigned at order creation, and it can be used as the id parameter.	integer	None.
ClientOrderId	Unique order identifier from your system.	string	Required String length: inclusive between 1 and 100
ClientOrderId2	Alternate order identifier from your system. For example, a PO number.	string	None.
WarehouseCode	Use "MEM" to send the order to the Memphis warehouse. Use "SLC" to send the order to the Salt Lake City warehouse. The default is "MEM".	string	None.
OrderStatus	Assigned by BGS to show the current status of the order.	string	None.
OrderDate		date	Required
ShipByDate		date	None.
DeliverByDate		date	None.
CompanyOrName		string	Required String length: inclusive between 2 and 35
Attention		string	String length: inclusive between 2 and 35
AddressLine1		string	Required String length: inclusive between 2 and 35
AddressLine2		string	String length: inclusive between 2 and 35
AddressLine3		string	String length: inclusive between 2 and 35
City		string	Required String length: inclusive between 2 and 35
State	Can accept the 2 digit state code or the state's full name.	string	Required String length: inclusive between 2 and 35
PostalCode		string	Required String length: inclusive between 2 and 35
Country	Can accept the 2 digit ISO code, the 3 digit ISO code, or the country's full name.	string	Required String length: inclusive between 2 and 35
Phone		string	String length: inclusive between 0 and 35
Email		string	String length: inclusive between 0 and 100
ShippingMethod	Acceptable values are: 3RDP_LTL, AAAC_LTL, ABFS_LTL, AVRT_LTL, Bestway_LTL, BGS_Freight, BGS_WillCall, CENT_LTL, DAFG_LTL, DHL_ExpressWorldwide, E2OP_LTL, ECHO_LTL, ECHO_LTL_EXPEDITED, EXLA_LTL, FEDEX_1DayFreight, FEDEX_2DayFreight, FEDEX_3DayFreight, FEDEX_ASRStandardOvernight, FEDEX_ASR2Day, FEDEX_ASRExpressSaver3Day, FEDEX_ASRGround, FEDEX_FirstOvernightFreight, FEDEX_FirstOvernight, FEDEX_PriorityOvernight, FEDEX_StandardOvernight, FEDEX_StandardOvernight_Saturday, FEDEX_2DayAM, FEDEX_2Day, FEDEX_ExpressSaver, FEDEX_GroundDelivery, FEDEX_Ground3rdParty, FEDEX_HomeDelivery, FWRD_LTL, GDN_International, HMES_LTL, NVX_Freight, NVX_WillCall, NVX_CustomerCollectAPiWater, NVX_NavispherePoolcorp, NVX_UTSAPiWater, NVX_APiFedEx, ODFL_LTL, RDWY_LTL, RLC_LTL, SAIA_LTL, SEFL_LTL, TAZ_LTL, UPGF_LTL, UPS_ASROvernightSaver, UPS_ASR2Day, UPS_ASR3Day, UPS_ASRGround, UPS_2ndDayAir, UPS_2ndDayAirAM, UPS_3DaySelect, UPS_Ground, UPS_GroundCommercial, UPS_GroundResidential, UPS_Ground3rdParty, UPS_Freight, UPS_MailInnovations, UPS_NextDayAir, UPS_NextDayAir_Saturday, UPS_NextDayAirEarlyAM, UPS_NextDayAirSaver, UPS_StandardtoCanada, UPS_SurePost, UPS_WorldwideExpedited, UPS_WorldwideExpress, USPS_FirstClass, USPS_FirstClassInternational, USPS_PriorityMail, USPS_PriorityMailASR, USPS_PriorityMailExpress, USPS_PriorityMailExpressInternational, USPS_PriorityMailInternational, and XPOL_LTL	string	None.
NotesToCustomerPackingSlip	Text submitted here will appear on the packing slip to the end customer.	string	String length: inclusive between 0 and 500
NotesToWarehouse	Text submitted here will appear on screen when picking an order.	string	String length: inclusive between 0 and 255
OrderDetailData		Collection of OrderDetailData	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": 2,
  "ClientOrderId": "sample string 3",
  "ClientOrderId2": "sample string 4",
  "WarehouseCode": "sample string 6",
  "OrderStatus": "sample string 7",
  "OrderDate": "2025-12-14T15:23:34.8577119+00:00",
  "ShipByDate": "2025-12-14T15:23:34.8577119+00:00",
  "DeliverByDate": "2025-12-14T15:23:34.8577119+00:00",
  "CompanyOrName": "sample string 10",
  "Attention": "sample string 11",
  "AddressLine1": "sample string 12",
  "AddressLine2": "sample string 13",
  "AddressLine3": "sample string 14",
  "City": "sample string 15",
  "State": "sample string 16",
  "PostalCode": "sample string 17",
  "Country": "sample string 18",
  "Phone": "sample string 19",
  "Email": "sample string 20",
  "ShippingMethod": "sample string 22",
  "NotesToCustomerPackingSlip": "sample string 23",
  "NotesToWarehouse": "sample string 24",
  "OrderDetailData": [
    {
      "ItemSKU": "sample string 4",
      "ItemSKU2": "sample string 5",
      "ItemDescription": "sample string 6",
      "ItemQuantity": 7,
      "IsKitHeader": true,
      "IsPicked": true,
      "PickType": "sample string 10",
      "OrderDetailLotData": [
        {
          "InventoryUnitId": 2,
          "LicenseId": "sample string 3",
          "Lot": "sample string 4",
          "ExpirationDate": "2025-12-14T15:23:34.8577119+00:00",
          "ItemQuantity": 5
        },
        {
          "InventoryUnitId": 2,
          "LicenseId": "sample string 3",
          "Lot": "sample string 4",
          "ExpirationDate": "2025-12-14T15:23:34.8577119+00:00",
          "ItemQuantity": 5
        }
      ]
    },
    {
      "ItemSKU": "sample string 4",
      "ItemSKU2": "sample string 5",
      "ItemDescription": "sample string 6",
      "ItemQuantity": 7,
      "IsKitHeader": true,
      "IsPicked": true,
      "PickType": "sample string 10",
      "OrderDetailLotData": [
        {
          "InventoryUnitId": 2,
          "LicenseId": "sample string 3",
          "Lot": "sample string 4",
          "ExpirationDate": "2025-12-14T15:23:34.8577119+00:00",
          "ItemQuantity": 5
        },
        {
          "InventoryUnitId": 2,
          "LicenseId": "sample string 3",
          "Lot": "sample string 4",
          "ExpirationDate": "2025-12-14T15:23:34.8577119+00:00",
          "ItemQuantity": 5
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<OrderData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCBGSAPI.Models">
  <AddressLine1>sample string 12</AddressLine1>
  <AddressLine2>sample string 13</AddressLine2>
  <AddressLine3>sample string 14</AddressLine3>
  <Attention>sample string 11</Attention>
  <CarrierCode>sample string 21</CarrierCode>
  <City>sample string 15</City>
  <ClientCode>sample string 5</ClientCode>
  <ClientOrderId>sample string 3</ClientOrderId>
  <ClientOrderId2>sample string 4</ClientOrderId2>
  <CompanyOrName>sample string 10</CompanyOrName>
  <Country>sample string 18</Country>
  <DeliverByDate>2025-12-14T15:23:34.8577119+00:00</DeliverByDate>
  <Email>sample string 20</Email>
  <ImportDate>2025-12-14T15:23:34.8577119+00:00</ImportDate>
  <NotesToCustomerPackingSlip>sample string 23</NotesToCustomerPackingSlip>
  <NotesToWarehouse>sample string 24</NotesToWarehouse>
  <OrderDataId>1</OrderDataId>
  <OrderDate>2025-12-14T15:23:34.8577119+00:00</OrderDate>
  <OrderDetailData>
    <OrderDetailData>
      <IsKitHeader>true</IsKitHeader>
      <IsPicked>true</IsPicked>
      <ItemDescription>sample string 6</ItemDescription>
      <ItemQuantity>7</ItemQuantity>
      <ItemSKU>sample string 4</ItemSKU>
      <ItemSKU2>sample string 5</ItemSKU2>
      <OrderDetailDataId>1</OrderDetailDataId>
      <OrderDetailId>2</OrderDetailId>
      <OrderDetailLotData>
        <OrderDetailLotData>
          <ExpirationDate>2025-12-14T15:23:34.8577119+00:00</ExpirationDate>
          <InventoryLotId>1</InventoryLotId>
          <InventoryUnitId>2</InventoryUnitId>
          <ItemQuantity>5</ItemQuantity>
          <LicenseId>sample string 3</LicenseId>
          <Lot>sample string 4</Lot>
          <MultiLotId>1</MultiLotId>
          <OrderDetailLotDataId>1</OrderDetailLotDataId>
        </OrderDetailLotData>
        <OrderDetailLotData>
          <ExpirationDate>2025-12-14T15:23:34.8577119+00:00</ExpirationDate>
          <InventoryLotId>1</InventoryLotId>
          <InventoryUnitId>2</InventoryUnitId>
          <ItemQuantity>5</ItemQuantity>
          <LicenseId>sample string 3</LicenseId>
          <Lot>sample string 4</Lot>
          <MultiLotId>1</MultiLotId>
          <OrderDetailLotDataId>1</OrderDetailLotDataId>
        </OrderDetailLotData>
      </OrderDetailLotData>
      <OrderId>3</OrderId>
      <PickType>sample string 10</PickType>
    </OrderDetailData>
    <OrderDetailData>
      <IsKitHeader>true</IsKitHeader>
      <IsPicked>true</IsPicked>
      <ItemDescription>sample string 6</ItemDescription>
      <ItemQuantity>7</ItemQuantity>
      <ItemSKU>sample string 4</ItemSKU>
      <ItemSKU2>sample string 5</ItemSKU2>
      <OrderDetailDataId>1</OrderDetailDataId>
      <OrderDetailId>2</OrderDetailId>
      <OrderDetailLotData>
        <OrderDetailLotData>
          <ExpirationDate>2025-12-14T15:23:34.8577119+00:00</ExpirationDate>
          <InventoryLotId>1</InventoryLotId>
          <InventoryUnitId>2</InventoryUnitId>
          <ItemQuantity>5</ItemQuantity>
          <LicenseId>sample string 3</LicenseId>
          <Lot>sample string 4</Lot>
          <MultiLotId>1</MultiLotId>
          <OrderDetailLotDataId>1</OrderDetailLotDataId>
        </OrderDetailLotData>
        <OrderDetailLotData>
          <ExpirationDate>2025-12-14T15:23:34.8577119+00:00</ExpirationDate>
          <InventoryLotId>1</InventoryLotId>
          <InventoryUnitId>2</InventoryUnitId>
          <ItemQuantity>5</ItemQuantity>
          <LicenseId>sample string 3</LicenseId>
          <Lot>sample string 4</Lot>
          <MultiLotId>1</MultiLotId>
          <OrderDetailLotDataId>1</OrderDetailLotDataId>
        </OrderDetailLotData>
      </OrderDetailLotData>
      <OrderId>3</OrderId>
      <PickType>sample string 10</PickType>
    </OrderDetailData>
  </OrderDetailData>
  <OrderId>2</OrderId>
  <OrderStatus>sample string 7</OrderStatus>
  <Phone>sample string 19</Phone>
  <PostalCode>sample string 17</PostalCode>
  <ShipByDate>2025-12-14T15:23:34.8577119+00:00</ShipByDate>
  <ShippingMethod>sample string 22</ShippingMethod>
  <State>sample string 16</State>
  <WarehouseCode>sample string 6</WarehouseCode>
</OrderData>