Acknowledge shipment receipt

curl --request PUT \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/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
}
'

import requests

url = "https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/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)

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_pk}/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_pk}/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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/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\n}")

	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))

}

HttpResponse<String> response = Unirest.put("https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/shipments/{id}/acknowledge/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/shipments/{id}/acknowledge/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "shipping_method": {
    "name": "White Glove Bronze",
    "code": "cory_white_glove",
    "id": 5,
    "type": "ltl (less than truck load)",
    "carrier": {
      "id": 229,
      "name": "Cory Companies",
      "code": "CJCD"
    },
    "generic_shipping_method": {
      "name": "LTL",
      "description": "Less than truckload (LTL)",
      "id": 5,
      "type": "ltl"
    }
  },
  "shipping_account": {
    "nickname": "Hobie FedEx",
    "id": 3,
    "owner": "Sample Owner",
    "carrier": {
      "id": 229,
      "name": "Cory Companies",
      "code": "CJCD"
    },
    "is_first_party_bill": true
  },
  "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",
    "tracking_details": [
      {
        "Time": "10-10-2022",
        "status": "Delivered",
        "status_detail": "Out for delivery",
        "id": 78895456,
        "country": "USA",
        "state": "New york",
        "city": "New york",
        "postal_code": "123R32"
      }
    ]
  },
  "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",
    "id": 10,
    "type": "residential",
    "name2": null,
    "street2": null,
    "phone1": "3105551212",
    "phone2": "3105551213",
    "fax": null,
    "email": null,
    "federal_tax_id": null
  },
  "ship_to": {
    "name1": "Demo Brand, Inc",
    "street1": "1332 Hermosa Ave",
    "city": "Hermosa Beach",
    "province": "CA",
    "postal_code": "90254",
    "country": "US",
    "id": 10,
    "type": "residential",
    "name2": null,
    "street2": null,
    "phone1": "3105551212",
    "phone2": "3105551213",
    "fax": null,
    "email": null,
    "federal_tax_id": null
  },
  "ship_from": {
    "name1": "Demo Brand, Inc",
    "street1": "1332 Hermosa Ave",
    "city": "Hermosa Beach",
    "province": "CA",
    "postal_code": "90254",
    "country": "US",
    "id": 10,
    "type": "residential",
    "name2": null,
    "street2": null,
    "phone1": "3105551212",
    "phone2": "3105551213",
    "fax": null,
    "email": null,
    "federal_tax_id": null
  },
  "ship_weight": 10,
  "ship_width": 1,
  "ship_length": 1,
  "ship_height": 1,
  "ship_girth": "<string>",
  "ship_volume": 4,
  "valid_packing_slip": true,
  "valid_shipping_label": true,
  "shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
  "error_logs": {
    "id": 677,
    "message": "Sample errors to fix",
    "count": 12,
    "created_at": "2022-08-10T15:24:56Z"
  },
  "acknowledged_at": "2022-08-10T15:24:56Z",
  "closed_at": null,
  "delivered_at": "2022-09-10T15:24:56Z",
  "shipped_at": "2022-09-10T15:24:56Z",
  "updated_at": "2022-09-10T15:25:56Z",
  "created_at": "2022-09-10T15:24:56Z",
  "shipment_lines": [
    {
      "id": 1001,
      "order_line_number": "1001",
      "quantity": 1,
      "part": 1,
      "freight_class": 50,
      "updated_at": "2022-09-10T15:24:56Z",
      "variant": {
        "id": 249,
        "name": "Var45",
        "brand": {
          "code": "marla-store",
          "id": 456,
          "name": "Marla Store"
        },
        "identifier": "123-DEF12345",
        "brand_identifier": "HATR",
        "upc": 555555555202,
        "retailer_identifiers": [
          {
            "id": 5642,
            "retailer": {
              "name": "Demo Retailer",
              "code": "demo-retailer",
              "id": 500,
              "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
              "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
              "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
              "joined_at": "2021-08-03T17:24:12Z",
              "is_rcn_retailer": false,
              "is_onboarded": false,
              "platform": "fabric",
              "requires_subscription": "disabled",
              "brand_permit_creation_allowed": false,
              "website": "https://demoabc.com",
              "status": "active"
            },
            "identifier": "SKU976",
            "name": "Retailer Sample"
          }
        ]
      }
    }
  ],
  "signature": null,
  "brand": {
    "code": "demo-brand",
    "id": 500,
    "name": "Marla Cielo",
    "joined_at": "2022-09-10T15:24:56Z",
    "logo_url": "https://images.revcascade.com/retailers/defaults/logo-lg.png",
    "cover_url": "https://images.revcascade.com/retailers/defaults/cover.png",
    "profile_tile_url": "https://images.revcascade.com/retailers/defaults/profile-tile.png",
    "website": null,
    "is_onboarded": false,
    "is_on_rcn": false,
    "requires_subscription": "enabled",
    "subscription_expires_at": "2024-09-19T13:32:10Z",
    "grace_period_ends_at": "2024-10-26T13:32:10Z",
    "subscription_is_expired": false,
    "subscription_is_on_grace_period": false,
    "subscription_is_delinquent": false,
    "inventory_policy": "managed",
    "status": "active"
  },
  "invoice_number": "RC123456"
}

PUT

retailers

{retailer_pk}

shipments

{id}

acknowledge

Acknowledge shipment receipt

curl --request PUT \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/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
}
'

import requests

url = "https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/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)

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_pk}/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_pk}/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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/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\n}")

	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))

}

HttpResponse<String> response = Unirest.put("https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/shipments/{id}/acknowledge/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/shipments/{id}/acknowledge/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\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\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "shipping_method": {
    "name": "White Glove Bronze",
    "code": "cory_white_glove",
    "id": 5,
    "type": "ltl (less than truck load)",
    "carrier": {
      "id": 229,
      "name": "Cory Companies",
      "code": "CJCD"
    },
    "generic_shipping_method": {
      "name": "LTL",
      "description": "Less than truckload (LTL)",
      "id": 5,
      "type": "ltl"
    }
  },
  "shipping_account": {
    "nickname": "Hobie FedEx",
    "id": 3,
    "owner": "Sample Owner",
    "carrier": {
      "id": 229,
      "name": "Cory Companies",
      "code": "CJCD"
    },
    "is_first_party_bill": true
  },
  "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",
    "tracking_details": [
      {
        "Time": "10-10-2022",
        "status": "Delivered",
        "status_detail": "Out for delivery",
        "id": 78895456,
        "country": "USA",
        "state": "New york",
        "city": "New york",
        "postal_code": "123R32"
      }
    ]
  },
  "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",
    "id": 10,
    "type": "residential",
    "name2": null,
    "street2": null,
    "phone1": "3105551212",
    "phone2": "3105551213",
    "fax": null,
    "email": null,
    "federal_tax_id": null
  },
  "ship_to": {
    "name1": "Demo Brand, Inc",
    "street1": "1332 Hermosa Ave",
    "city": "Hermosa Beach",
    "province": "CA",
    "postal_code": "90254",
    "country": "US",
    "id": 10,
    "type": "residential",
    "name2": null,
    "street2": null,
    "phone1": "3105551212",
    "phone2": "3105551213",
    "fax": null,
    "email": null,
    "federal_tax_id": null
  },
  "ship_from": {
    "name1": "Demo Brand, Inc",
    "street1": "1332 Hermosa Ave",
    "city": "Hermosa Beach",
    "province": "CA",
    "postal_code": "90254",
    "country": "US",
    "id": 10,
    "type": "residential",
    "name2": null,
    "street2": null,
    "phone1": "3105551212",
    "phone2": "3105551213",
    "fax": null,
    "email": null,
    "federal_tax_id": null
  },
  "ship_weight": 10,
  "ship_width": 1,
  "ship_length": 1,
  "ship_height": 1,
  "ship_girth": "<string>",
  "ship_volume": 4,
  "valid_packing_slip": true,
  "valid_shipping_label": true,
  "shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
  "error_logs": {
    "id": 677,
    "message": "Sample errors to fix",
    "count": 12,
    "created_at": "2022-08-10T15:24:56Z"
  },
  "acknowledged_at": "2022-08-10T15:24:56Z",
  "closed_at": null,
  "delivered_at": "2022-09-10T15:24:56Z",
  "shipped_at": "2022-09-10T15:24:56Z",
  "updated_at": "2022-09-10T15:25:56Z",
  "created_at": "2022-09-10T15:24:56Z",
  "shipment_lines": [
    {
      "id": 1001,
      "order_line_number": "1001",
      "quantity": 1,
      "part": 1,
      "freight_class": 50,
      "updated_at": "2022-09-10T15:24:56Z",
      "variant": {
        "id": 249,
        "name": "Var45",
        "brand": {
          "code": "marla-store",
          "id": 456,
          "name": "Marla Store"
        },
        "identifier": "123-DEF12345",
        "brand_identifier": "HATR",
        "upc": 555555555202,
        "retailer_identifiers": [
          {
            "id": 5642,
            "retailer": {
              "name": "Demo Retailer",
              "code": "demo-retailer",
              "id": 500,
              "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
              "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
              "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
              "joined_at": "2021-08-03T17:24:12Z",
              "is_rcn_retailer": false,
              "is_onboarded": false,
              "platform": "fabric",
              "requires_subscription": "disabled",
              "brand_permit_creation_allowed": false,
              "website": "https://demoabc.com",
              "status": "active"
            },
            "identifier": "SKU976",
            "name": "Retailer Sample"
          }
        ]
      }
    }
  ],
  "signature": null,
  "brand": {
    "code": "demo-brand",
    "id": 500,
    "name": "Marla Cielo",
    "joined_at": "2022-09-10T15:24:56Z",
    "logo_url": "https://images.revcascade.com/retailers/defaults/logo-lg.png",
    "cover_url": "https://images.revcascade.com/retailers/defaults/cover.png",
    "profile_tile_url": "https://images.revcascade.com/retailers/defaults/profile-tile.png",
    "website": null,
    "is_onboarded": false,
    "is_on_rcn": false,
    "requires_subscription": "enabled",
    "subscription_expires_at": "2024-09-19T13:32:10Z",
    "grace_period_ends_at": "2024-10-26T13:32:10Z",
    "subscription_is_expired": false,
    "subscription_is_on_grace_period": false,
    "subscription_is_delinquent": false,
    "inventory_policy": "managed",
    "status": "active"
  },
  "invoice_number": "RC123456"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Shipment ID

retailer_pk

number

required

Retailer ID

Body

application/json

order_id

integer

required

Order ID

Example:

677

batch_number

integer | null

Batch number of shipment

Required range: -2147483648 <= x <= 2147483647

Example:

6

label_reference

string | null

Label reference

Maximum string length: 30

Example:

"Sample label 123"

shipping_method

object

Show child attributes

shipping_account

object

Show child attributes

tracking_number

string | null

Tracking number for shipment

Maximum string length: 128

Example:

"1Z9999999999999988"

tracking

object

Show child attributes

has_commercial_invoice

boolean

true: Shipment has commercial invoice
Shipment does not have commercial invoice

Example:

true

canceled_at

string<date-time> | null

Time of cancellation (UTC format)

Example:

null

sold_to

object

Show child attributes

ship_to

object

Show child attributes

ship_from

object

Show child attributes

ship_weight

number | null

Shipment weight

Example:

10

ship_width

number | null

Shipment width

Example:

1

ship_length

number | null

Shipment length

Example:

1

ship_height

number | null

Shipment height

Example:

1

shipping_provider_identifier

string | null

Identifier of the shipping provider

Maximum string length: 64

Example:

"shp_3a61e10243da49ab92f0e3861d5d256b"

error_logs

object

Show child attributes

acknowledged_at

string<date-time> | null

Time of acknowledgement (UTC format)

Example:

"2022-08-10T15:24:56Z"

closed_at

string<date-time> | null

Time of shipment closure (UTC format)

Example:

null

delivered_at

string<date-time> | null

Time of delivery (UTC format)

Example:

"2022-09-10T15:24:56Z"

shipped_at

string<date-time> | null

Time of shipping (UTC format)

Example:

"2022-09-10T15:24:56Z"

signature

enum<string> | null

Signature criteria

Available options:

required,

not_required,

adult

Example:

null

brand

object

Show child attributes

Response

order_id

integer

required

Order ID

Example:

677

integer

read-only

Shipment ID

Example:

767

batch_number

integer | null

Batch number of shipment

Required range: -2147483648 <= x <= 2147483647

Example:

6

label_reference

string | null

Label reference

Maximum string length: 30

Example:

"Sample label 123"

ordered_at

string<date-time>

read-only

Time of shipment creation (UTC format)

Example:

"2021-09-10T15:24:56Z"

customer_order_number

string

read-only

Customer order number

Minimum string length: 1

Example:

"765637"

retailer_order_number

string

read-only

Retailer order number

Minimum string length: 1

Example:

"66367"

purchase_order_number

string

read-only

Purchase order number

Minimum string length: 1

Example:

"PO-576"

shipping_method

object

Show child attributes

shipping_account

object

Show child attributes

tracking_number

string | null

Tracking number for shipment

Maximum string length: 128

Example:

"1Z9999999999999988"

tracking_url

string

read-only

URL for tracking shipment

Example:

"https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988"

tracking

object

Show child attributes

status

string

read-only

Status of shipment

Minimum string length: 1

Example:

"Shipped"

is_acknowledged

boolean

read-only

true: Shipment is acknowledged
false: Shipment is not acknowledged

Example:

true

has_commercial_invoice

boolean

true: Shipment has commercial invoice
Shipment does not have commercial invoice

Example:

true

canceled_at

string<date-time> | null

Time of cancellation (UTC format)

Example:

null

sold_to

object

Show child attributes

ship_to

object

Show child attributes

ship_from

object

Show child attributes

ship_weight

number | null

Shipment weight

Example:

10

ship_width

number | null

Shipment width

Example:

1

ship_length

number | null

Shipment length

Example:

1

ship_height

number | null

Shipment height

Example:

1

ship_girth

string

read-only

Shipment girth

ship_volume

string

read-only

Shipment volume

Example:

4

valid_packing_slip

boolean

read-only

true: Shipment has valid packing slip
false: Shipment does not valid packing slip

Example:

true

valid_shipping_label

boolean

read-only

true: Shipment has valid shipping label
false: Shipment does not valid valid shipping label

Example:

true

shipping_provider_identifier

string | null

Identifier of the shipping provider

Maximum string length: 64

Example:

"shp_3a61e10243da49ab92f0e3861d5d256b"

error_logs

object

Show child attributes

acknowledged_at

string<date-time> | null

Time of acknowledgement (UTC format)

Example:

"2022-08-10T15:24:56Z"

closed_at

string<date-time> | null

Time of shipment closure (UTC format)

Example:

null

delivered_at

string<date-time> | null

Time of delivery (UTC format)

Example:

"2022-09-10T15:24:56Z"

shipped_at

string<date-time> | null

Time of shipping (UTC format)

Example:

"2022-09-10T15:24:56Z"

updated_at

string<date-time>

read-only

Time of shipment update (UTC format)

Example:

"2022-09-10T15:25:56Z"

created_at

string<date-time>

read-only

Time of shipment creation (UTC format)

Example:

"2022-09-10T15:24:56Z"

shipment_lines

object[]

read-only

Show child attributes

signature

enum<string> | null

Signature criteria

Available options:

required,

not_required,

adult

Example:

null

brand

object

Show child attributes

invoice_number

string

read-only

Invoice number

Example:

"RC123456"

List fulfillments or shipments from vendors Get active permits

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Acknowledge shipment receipt

Authorizations

Path Parameters

Body

Response