Rel doc - Rel

PUT

/orders/parcels/ordersparcelcanceler{?onlyRemoveBatchShipRecords,onlyRemoveTrackingInfo}

Cancel parcel shipment for orders
Success status: 200

Name	Data Type	Description
onlyRemoveBatchShipRecords	bool	set to true to clear orders that have been ophaned in a batch shipment (order has a ship record but batch never completed so you want to get rid of the ship record)
onlyRemoveTrackingInfo	bool	set to true to void the shipping info(add void date, clear tracking numbers, etc.) from the database only and not hit the api to be able to ship again

specify the orders to be canceled

	Type	Description
OrderIdentifiers	IEnumerable<Generic.Models.OrderIdentifier>	identifies orders to be affected
Id	int

Sample content-type: application/hal+json

{
  "orderIdentifiers": [
    {
      "id": 1
    }
  ]
}

	Type	Description
FaultedOrders	Generic.Models.Exceptions.ListException	container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops
Message	string
Faults	IList<Generic.Models.Exceptions.ListEntryFault>
EntryNumber	int	1-indexed position in the source list
EntryInfo	string	optional info about the entry in the source list, such as id, sku, ref#, etc.
WmsException	Generic.Models.Exceptions.WmsExceptionBase	for more details at runtime see which WmsExceptionBase-derived exception it is
ErrorCode	string	could have been a number, but is a short string for human readability; not to be localized
Hint	string	helpful word or two if the thrower happens to know more things; not to be localized
Message	string
InnerException	System.Exception
SuccessIds	IEnumerable<int>
SuccessCount	int
Document	Byte[]

Sample accept: application/hal+json

{
  "faultedOrders": {
    "message": "ListException: Faults [{EntryNumber 1, }]",
    "faults": [
      {
        "entryNumber": 1,
        "entryInfo": "str"
      }
    ],
    "data": {},
    "helpLink": "str",
    "source": "str",
    "hResult": 3
  },
  "successIds": [
    1
  ],
  "successCount": 1,
  "document": "QA=="
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.