Track

PreviousLabel Next/

sales Shipment Track Repository V1Save Post

Performs persist operations for a specified shipment track.

post

/V1/shipment/track

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"entity":{"order_id":"<integer>","parent_id":"<integer>","weight":"<number>","qty":"<number>","description":"<string>","track_number":"<string>","title":"<string>","carrier_code":"<string>","created_at":"<string>","entity_id":"<integer>","updated_at":"<string>","extension_attributes":"<object>"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/shipment/track' \
  --header 'Content-Type: application/json' \
  --data '{
    "entity": {
      "order_id": "<integer>",
      "parent_id": "<integer>",
      "weight": "<number>",
      "qty": "<number>",
      "description": "<string>",
      "track_number": "<string>",
      "title": "<string>",
      "carrier_code": "<string>",
      "created_at": "<string>",
      "entity_id": "<integer>",
      "updated_at": "<string>",
      "extension_attributes": "<object>"
    }
  }'

200

400

401

500

{
  "order_id": "<integer>",
  "parent_id": "<integer>",
  "weight": "<number>",
  "qty": "<number>",
  "description": "<string>",
  "track_number": "<string>",
  "title": "<string>",
  "carrier_code": "<string>",
  "created_at": "<string>",
  "entity_id": "<integer>",
  "updated_at": "<string>",
  "extension_attributes": "<object>"
}

sales Shipment Track Repository V1Delete By Id Delete

Deletes a specified shipment track by ID.

delete

/V1/shipment/track/{id}

Path parameters

idstringrequired

(Required) The shipment track ID.

Example: <integer>