Inward Delete
Allows customers to remove an existing warehousing inward in the internal WMS as long as the order has not been processed.
Note: No content will be returned
Access
To get access to this API, please fill in the Developer Registration form
Resource URI
Make an HTTP DELETE request to:
https://api.mainfreight.com/Warehousing/1.1/Customers/Inward/{inwardID}/?region={add region}
Resource Information
| Type | Value | ||
|---|---|---|---|
| Authentication | API Key | ||
| Response Formats | JSON / XML | ||
| HTTP Methods | DEL | ||
| API Version | 1.1 | ||
HTTP Headers
You must add the following HTTP Headers to your request:
| Header | Type | Description |
|---|---|---|
| Content-Type | string | Request content type. Supported types are "application/json" or "application/xml." |
| Authorization | string |
The word "Secret" followed by a space, then your unique Logistics API Key. e.g: Secret wdnOId93-VXZECxvVRPQEJZNxPB5XZ... |
Parameters
You must provide the parameters marked as required:
HTTP Request Parameters
| Header | Description | Type | Required |
|---|---|---|---|
| inward id |
Provided in the API response when order is created |
string | Yes |
| region |
Region code, a list of supported regions for each country can be found here |
string | Yes |
Response Parameters
Code samples
To Delete an Inward you will need to set the HTTP method to DEL and pass the Inward ID into the URL as a parameter:
- URL
https://api.mainfreight.com/Warehousing/1.1/Customer/Inward/091BE892-E95B-4E47-8CA8-AB730C7E0528/?region=US
You are going an HTTP response similar to this:
- RESPONSE HTTP
Responds with an HTTP 204 response code on success.