Updates the collect-on-delivery (COD) requirement for an existing Order.
| Post | api/order/codRequirement |
Resource Path: /sites/{company-id}/api/order/codRequirement
Uri: https://secure.ontime360.com/sites/{company-id}/api/order/codRequirement
| Name | Description | Data Type |
|---|---|---|
| id | The unique identifier of the Order as a Guid. | string |
| trackingNumber | The tracking number assigned to the Order as a String. | string |
| amountToCollect | The collect-on-delivery (COD) amount as a Decimal | number |
| requireCollectionCOD | The collection collect-on-delivery (COD) requirement of the Order as a Boolean. | boolean |
| requireDeliveryCOD | The delivery collect-on-delivery (COD) requirement of the Order as a Boolean. | boolean |
The request body is of type object.
The response body is of type object.
Returns true if the Order's collect-on-delivery (COD) requirement was successfully updated. Otherwise, returns false.| Fault | Description |
|---|---|
| 400 | Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information. |
| 401 | Authorization key is invalid or no longer exists. |
| 403 | Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information. |