Acknowledge shipment receipt - Fabric
Acknowledge shipment receipt
cURL
curl --request PUT \
--url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/{id}/acknowledge/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"order_id": 677,
"batch_number": 6,
"label_reference": "Sample label 123",
"tracking_number": "1Z9999999999999988",
"tracking": {
"picked_up_at": "2022-08-10T15:24:56Z",
"delivered_at": "2022-09-10T15:24:56Z"
},
"has_commercial_invoice": true,
"canceled_at": null,
"ship_weight": 10,
"ship_width": 1,
"ship_length": 1,
"ship_height": 1,
"shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
"error_logs": {
"message": "Sample errors to fix"
},
"acknowledged_at": "2022-08-10T15:24:56Z",
"closed_at": null,
"delivered_at": "2022-09-10T15:24:56Z",
"shipped_at": "2022-09-10T15:24:56Z",
"signature": null
}
'
Python
import requests
url = "https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/{id}/acknowledge/"
payload = {
"order_id": 677,
"batch_number": 6,
"label_reference": "Sample label 123",
"tracking_number": "1Z9999999999999988",
"tracking": {
"picked_up_at": "2022-08-10T15:24:56Z",
"delivered_at": "2022-09-10T15:24:56Z"
},
"has_commercial_invoice": True,
"canceled_at": None,
"ship_weight": 10,
"ship_width": 1,
"ship_length": 1,
"ship_height": 1,
"shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
"error_logs": { "message": "Sample errors to fix" },
"acknowledged_at": "2022-08-10T15:24:56Z",
"closed_at": None,
"delivered_at": "2022-09-10T15:24:56Z",
"shipped_at": "2022-09-10T15:24:56Z",
"signature": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)
JavaScript (Fetch)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
order_id: 677,
batch_number: 6,
label_reference: 'Sample label 123',
tracking_number: '1Z9999999999999988',
tracking: {picked_up_at: '2022-08-10T15:24:56Z', delivered_at: '2022-09-10T15:24:56Z'},
has_commercial_invoice: true,
canceled_at: null,
ship_weight: 10,
ship_width: 1,
ship_length: 1,
ship_height: 1,
shipping_provider_identifier: 'shp_3a61e10243da49ab92f0e3861d5d256b',
error_logs: {message: 'Sample errors to fix'},
acknowledged_at: '2022-08-10T15:24:56Z',
closed_at: null,
delivered_at: '2022-09-10T15:24:56Z',
shipped_at: '2022-09-10T15:24:56Z',
signature: null
})
};
fetch('https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/{id}/acknowledge/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
PHP
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/{id}/acknowledge/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'order_id' => 677,
'batch_number' => 6,
'label_reference' => 'Sample label 123',
'tracking_number' => '1Z9999999999999988',
'tracking' => [
'picked_up_at' => '2022-08-10T15:24:56Z',
'delivered_at' => '2022-09-10T15:24:56Z'
],
'has_commercial_invoice' => true,
'canceled_at' => null,
'ship_weight' => 10,
'ship_width' => 1,
'ship_length' => 1,
'ship_height' => 1,
'shipping_provider_identifier' => 'shp_3a61e10243da49ab92f0e3861d5d256b',
'error_logs' => [
'message' => 'Sample errors to fix'
],
'acknowledged_at' => '2022-08-10T15:24:56Z',
'closed_at' => null,
'delivered_at' => '2022-09-10T15:24:56Z',
'shipped_at' => '2022-09-10T15:24:56Z',
'signature' => null
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Go
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/{id}/acknowledge/"
payload := strings.NewReader("{\n \"order_id\": 677,\n \"batch_number\": 6,\n \"label_reference\": \"Sample label 123\",\n \"tracking_number\": \"1Z9999999999999988\",\n \"tracking\": {\n \"picked_up_at\": \"2022-08-10T15:24:56Z\",\n \"delivered_at\": \"2022-09-10T15:24:56Z\"\n },\n \"has_commercial_invoice\": true,\n \"canceled_at\": null,\n \"ship_weight\": 10,\n \"ship_width\": 1,\n \"ship_length\": 1,\n \"ship_height\": 1,\n \"shipping_provider_identifier\": \"shp_3a61e10243da49ab92f0e3861d5d256b\",\n \"error_logs\": {\n \"message\": \"Sample errors to fix\"\n },\n \"acknowledged_at\": \"2022-08-10T15:24:56Z\",\n \"closed_at\": null,\n \"delivered_at\": \"2022-09-10T15:24:56Z\",\n \"shipped_at\": \"2022-09-10T15:24:56Z\",\n \"signature\": null}\")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
Example JSON Response
{
"order_id": 677,
"id": 767,
"batch_number": 6,
"label_reference": "Sample label 123",
"ordered_at": "2021-09-10T15:24:56Z",
"customer_order_number": "765637",
"retailer_order_number": "66367",
"purchase_order_number": "PO-576",
"tracking_number": "1Z9999999999999988",
"tracking_url": "https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988",
"tracking": {
"picked_up_at": "2022-08-10T15:24:56Z",
"delivered_at": "2022-09-10T15:24:56Z"
},
"status": "Shipped",
"is_acknowledged": true,
"has_commercial_invoice": true,
"canceled_at": null,
"sold_to": {
"name1": "Demo Brand, Inc",
"street1": "1332 Hermosa Ave",
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US"
},
"ship_to": {
"name1": "Demo Brand, Inc",
"street1": "1332 Hermosa Ave",
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US"
},
"ship_from": {
"name1": "Demo Brand, Inc",
"street1": "1332 Hermosa Ave",
"city": "Hermosa Beach",
"province": "CA",
"postal_code": "90254",
"country": "US"
},
"ship_weight": 10,
"ship_width": 1,
"ship_length": 1,
"ship_height": 1,
"shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
"error_logs": {
"message": "Sample errors to fix"
},
"acknowledged_at": "2022-08-10T15:24:56Z",
"delivered_at": "2022-09-10T15:24:56Z",
"shipped_at": "2022-09-10T15:24:56Z"
}
Authorizations
The authorization token is required to access this endpoint. Use the format: Bearer <token>.