Ship

PreviousRefund NextInvoice

sales Ship Order V1Execute Post

Creates new Shipment for given Order.

post

/V1/order/{orderId}/ship

Path parameters

orderIdstringrequired

(Required)

Example: <integer>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/order/{orderId}/ship' \
  --header 'Content-Type: application/json' \
  --data '{
    "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>"
      }
    }
  }'

200

401

500

-63572739