Ship

sales Ship Order V1Execute Post

post

Creates new Shipment for given Order.

Path parameters

orderIdstringRequired

(Required)

Example: <integer>

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"items":[{"order_item_id":"<integer>","qty":"<number>","extension_attributes":"<object>"},{"order_item_id":"<integer>","qty":"<number>","extension_attributes":"<object>"}],"notify":"<boolean>","appendComment":"<boolean>","comment":{"comment":"<string>","is_visible_on_front":"<integer>","extension_attributes":"<object>"},"tracks":[{"track_number":"<string>","title":"<string>","carrier_code":"<string>","extension_attributes":"<object>"},{"track_number":"<string>","title":"<string>","carrier_code":"<string>","extension_attributes":"<object>"}],"packages":[{"extension_attributes":"<object>"},{"extension_attributes":"<object>"}],"arguments":{"extension_attributes":{"source_code":"<string>"}}}

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/V1/order/{orderId}/ship

HTTPcURLJavaScriptPython

POST /V1/order/{orderId}/ship HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 697

{
  "items": [
    {
      "order_item_id": "<integer>",
      "qty": "<number>",
      "extension_attributes": "<object>"
    },
    {
      "order_item_id": "<integer>",
      "qty": "<number>",
      "extension_attributes": "<object>"
    }
  ],
  "notify": "<boolean>",
  "appendComment": "<boolean>",
  "comment": {
    "comment": "<string>",
    "is_visible_on_front": "<integer>",
    "extension_attributes": "<object>"
  },
  "tracks": [
    {
      "track_number": "<string>",
      "title": "<string>",
      "carrier_code": "<string>",
      "extension_attributes": "<object>"
    },
    {
      "track_number": "<string>",
      "title": "<string>",
      "carrier_code": "<string>",
      "extension_attributes": "<object>"
    }
  ],
  "packages": [
    {
      "extension_attributes": "<object>"
    },
    {
      "extension_attributes": "<object>"
    }
  ],
  "arguments": {
    "extension_attributes": {
      "source_code": "<string>"
    }
  }
}

-63572739