Deliveries

Part of the Inventory API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).

List deliveries

GET /admin/api/v1/inventories/deliveries

Retrieve a paginated list of deliveries

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include	`operationType,moves`
`filter[id]`	string	No	Filter by delivery IDs	`1,2`
`filter[name]`	string	No	Filter by delivery name	`WH/OUT/0001`
`filter[state]`	string	No	Filter by delivery state	`draft`
`filter[move_type]`	string	No	Filter by move type	`direct`
`filter[partner_id]`	string	No	Filter by partner IDs	`1,2`
`filter[user_id]`	string	No	Filter by responsible user IDs	`1,2`
`filter[company_id]`	string	No	Filter by company IDs	`1,2`
`filter[operation_type_id]`	string	No	Filter by operation type IDs	`1,2`
`sort`	string	No	Sort field	`-created_at`
`page`	integer	No	Page number	`1`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/inventories/deliveries?include=operationType%2Cmoves&filter%5Bid%5D=1%2C2&filter%5Bname%5D=WH%2FOUT%2F0001&filter%5Bstate%5D=draft&filter%5Bmove_type%5D=direct&filter%5Bpartner_id%5D=1%2C2&filter%5Buser_id%5D=1%2C2&filter%5Bcompany_id%5D=1%2C2&filter%5Boperation_type_id%5D=1%2C2&sort=-created_at&page=1" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries?include=operationType%2Cmoves&filter%5Bid%5D=1%2C2&filter%5Bname%5D=WH%2FOUT%2F0001&filter%5Bstate%5D=draft&filter%5Bmove_type%5D=direct&filter%5Bpartner_id%5D=1%2C2&filter%5Buser_id%5D=1%2C2&filter%5Bcompany_id%5D=1%2C2&filter%5Boperation_type_id%5D=1%2C2&sort=-created_at&page=1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/inventories/deliveries?include=operationType%2Cmoves&filter%5Bid%5D=1%2C2&filter%5Bname%5D=WH%2FOUT%2F0001&filter%5Bstate%5D=draft&filter%5Bmove_type%5D=direct&filter%5Bpartner_id%5D=1%2C2&filter%5Buser_id%5D=1%2C2&filter%5Bcompany_id%5D=1%2C2&filter%5Boperation_type_id%5D=1%2C2&sort=-created_at&page=1', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries?include=operationType%2Cmoves&filter%5Bid%5D=1%2C2&filter%5Bname%5D=WH%2FOUT%2F0001&filter%5Bstate%5D=draft&filter%5Bmove_type%5D=direct&filter%5Bpartner_id%5D=1%2C2&filter%5Buser_id%5D=1%2C2&filter%5Bcompany_id%5D=1%2C2&filter%5Boperation_type_id%5D=1%2C2&sort=-created_at&page=1"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": [
    {
      "id": null,
      "name": "voluptatem vero",
      "origin": null,
      "move_type": "direct",
      "state": "draft",
      "is_favorite": false,
      "description": null,
      "has_deadline_issue": false,
      "is_printed": false,
      "is_locked": false,
      "deadline": null,
      "scheduled_at": "2026-10-12T10:50:00.000000Z",
      "closed_at": null,
      "created_at": null,
      "updated_at": null
    },
    {
      "id": null,
      "name": "sint quis",
      "origin": null,
      "move_type": "direct",
      "state": "draft",
      "is_favorite": false,
      "description": null,
      "has_deadline_issue": false,
      "is_printed": false,
      "is_locked": false,
      "deadline": null,
      "scheduled_at": "2026-10-12T10:50:00.000000Z",
      "closed_at": null,
      "created_at": null,
      "updated_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "page": null,
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Create delivery

POST /admin/api/v1/inventories/deliveries

Create a new delivery

Body parameters

Parameter	Type	Required	Description
`partner_id`	integer	No	Partner ID (receive from, contact, or delivery address based on operation type). Must match an existing stored value.
`operation_type_id`	integer	No	Operation type ID. If omitted, the API resolves the default operation type for the resource. Must match an existing stored value.
`source_location_id`	integer	No	Source location ID. Must match an existing stored value.
`destination_location_id`	integer	No	Destination location ID. Must match an existing stored value.
`user_id`	integer	No	Responsible user ID. Must match an existing stored value.
`move_type`	string	No	Shipping policy.
`scheduled_at`	string	No	Scheduled datetime. Must be a valid date.
`origin`	string	No	Source document reference. Must not be greater than 255 characters.
`description`	string	No	Operation note.
`moves`	object[]	No	Optional operation moves payload.
`moves[].id`	integer	No	Must match an existing stored value.
`moves[].product_id`	integer	Yes	Must match an existing stored value.
`moves[].product_uom_qty`	number	Yes	Must be at least 0. Must not be greater than 99999999999.
`moves[].uom_id`	integer	No	Must match an existing stored value.
`moves[].final_location_id`	integer	No	Must match an existing stored value.
`moves[].description_picking`	string	No	Must not be greater than 255 characters.
`moves[].scheduled_at`	string	No	Must be a valid date.
`moves[].deadline`	string	No	Must be a valid date.
`moves[].product_packaging_id`	integer	No	Must match an existing stored value.
`moves[].quantity`	number	No	Must be at least 0. Must not be greater than 99999999999.
`moves[].is_picked`	boolean	No

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/inventories/deliveries" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "partner_id": 1,
  "operation_type_id": 1,
  "source_location_id": 1,
  "destination_location_id": 2,
  "user_id": 1,
  "move_type": "direct",
  "scheduled_at": "2026-02-25 10:00:00",
  "origin": "SO/00001",
  "description": "Handle with care.",
  "moves": [
    {
      "product_id": 1,
      "product_uom_qty": 5,
      "uom_id": 1,
      "quantity": 22,
      "is_picked": false
    }
  ]
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "partner_id": 1,
  "operation_type_id": 1,
  "source_location_id": 1,
  "destination_location_id": 2,
  "user_id": 1,
  "move_type": "direct",
  "scheduled_at": "2026-02-25 10:00:00",
  "origin": "SO/00001",
  "description": "Handle with care.",
  "moves": [
    {
      "product_id": 1,
      "product_uom_qty": 5,
      "uom_id": 1,
      "quantity": 22,
      "is_picked": false
    }
  ]
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/deliveries', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'partner_id' => 1,
    'operation_type_id' => 1,
    'source_location_id' => 1,
    'destination_location_id' => 2,
    'user_id' => 1,
    'move_type' => 'direct',
    'scheduled_at' => '2026-02-25 10:00:00',
    'origin' => 'SO/00001',
    'description' => 'Handle with care.',
    'moves' => [
      [
        'product_id' => 1,
        'product_uom_qty' => 5,
        'uom_id' => 1,
        'quantity' => 22,
        'is_picked' => false,
      ],
    ],
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "partner_id": 1,
    "operation_type_id": 1,
    "source_location_id": 1,
    "destination_location_id": 2,
    "user_id": 1,
    "move_type": "direct",
    "scheduled_at": "2026-02-25 10:00:00",
    "origin": "SO/00001",
    "description": "Handle with care.",
    "moves": [
        {
            "product_id": 1,
            "product_uom_qty": 5,
            "uom_id": 1,
            "quantity": 22,
            "is_picked": False,
        },
    ],
}

response = requests.post(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 201

json

{
  "data": {
    "id": null,
    "name": "et animi",
    "origin": null,
    "move_type": "direct",
    "state": "draft",
    "is_favorite": false,
    "description": null,
    "has_deadline_issue": false,
    "is_printed": false,
    "is_locked": false,
    "deadline": null,
    "scheduled_at": "2026-10-12T10:50:00.000000Z",
    "closed_at": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Delivery created successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Show delivery

GET /admin/api/v1/inventories/deliveries/{id}

Retrieve a specific delivery by ID

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The delivery ID

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include	`operationType,moves`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}?include=operationType%2Cmoves" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries/{id}?include=operationType%2Cmoves", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/inventories/deliveries/{id}?include=operationType%2Cmoves', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}?include=operationType%2Cmoves"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "aut adipisci",
    "origin": null,
    "move_type": "direct",
    "state": "draft",
    "is_favorite": false,
    "description": null,
    "has_deadline_issue": false,
    "is_printed": false,
    "is_locked": false,
    "deadline": null,
    "scheduled_at": "2026-10-12T10:50:00.000000Z",
    "closed_at": null,
    "created_at": null,
    "updated_at": null
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Update delivery

PUT /admin/api/v1/inventories/deliveries/{id}

Update an existing delivery

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The delivery ID

Body parameters

Parameter	Type	Required	Description
`partner_id`	integer	No	Partner ID (receive from, contact, or delivery address based on operation type). Must match an existing stored value.
`operation_type_id`	integer	No	Operation type ID. If omitted, the API resolves the default operation type for the resource. Must match an existing stored value.
`source_location_id`	integer	No	Source location ID. Must match an existing stored value.
`destination_location_id`	integer	No	Destination location ID. Must match an existing stored value.
`user_id`	integer	No	Responsible user ID. Must match an existing stored value.
`move_type`	string	No	Shipping policy.
`scheduled_at`	string	No	Scheduled datetime. Must be a valid date.
`origin`	string	No	Source document reference. Must not be greater than 255 characters.
`description`	string	No	Operation note.
`moves`	object[]	No	Optional operation moves payload.
`moves[].id`	integer	No	Must match an existing stored value.
`moves[].product_id`	integer	No	Must match an existing stored value.
`moves[].product_uom_qty`	number	No	Must be at least 0. Must not be greater than 99999999999.
`moves[].uom_id`	integer	No	Must match an existing stored value.
`moves[].final_location_id`	integer	No	Must match an existing stored value.
`moves[].description_picking`	string	No	Must not be greater than 255 characters.
`moves[].scheduled_at`	string	No	Must be a valid date.
`moves[].deadline`	string	No	Must be a valid date.
`moves[].product_packaging_id`	integer	No	Must match an existing stored value.
`moves[].quantity`	number	No	Must be at least 0. Must not be greater than 99999999999.
`moves[].is_picked`	boolean	No

cURLJavaScriptPHPPython

bash

curl -X PUT "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "partner_id": 1,
  "operation_type_id": 1,
  "source_location_id": 1,
  "destination_location_id": 2,
  "user_id": 1,
  "move_type": "direct",
  "scheduled_at": "2026-02-25 10:00:00",
  "origin": "SO/00001",
  "description": "Handle with care.",
  "moves": [
    {
      "product_id": 1,
      "product_uom_qty": 5,
      "uom_id": 1,
      "quantity": 22,
      "is_picked": true
    }
  ]
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries/{id}", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "partner_id": 1,
  "operation_type_id": 1,
  "source_location_id": 1,
  "destination_location_id": 2,
  "user_id": 1,
  "move_type": "direct",
  "scheduled_at": "2026-02-25 10:00:00",
  "origin": "SO/00001",
  "description": "Handle with care.",
  "moves": [
    {
      "product_id": 1,
      "product_uom_qty": 5,
      "uom_id": 1,
      "quantity": 22,
      "is_picked": true
    }
  ]
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-domain.com/admin/api/v1/inventories/deliveries/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'partner_id' => 1,
    'operation_type_id' => 1,
    'source_location_id' => 1,
    'destination_location_id' => 2,
    'user_id' => 1,
    'move_type' => 'direct',
    'scheduled_at' => '2026-02-25 10:00:00',
    'origin' => 'SO/00001',
    'description' => 'Handle with care.',
    'moves' => [
      [
        'product_id' => 1,
        'product_uom_qty' => 5,
        'uom_id' => 1,
        'quantity' => 22,
        'is_picked' => true,
      ],
    ],
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "partner_id": 1,
    "operation_type_id": 1,
    "source_location_id": 1,
    "destination_location_id": 2,
    "user_id": 1,
    "move_type": "direct",
    "scheduled_at": "2026-02-25 10:00:00",
    "origin": "SO/00001",
    "description": "Handle with care.",
    "moves": [
        {
            "product_id": 1,
            "product_uom_qty": 5,
            "uom_id": 1,
            "quantity": 22,
            "is_picked": True,
        },
    ],
}

response = requests.put(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "et animi",
    "origin": null,
    "move_type": "direct",
    "state": "draft",
    "is_favorite": false,
    "description": null,
    "has_deadline_issue": false,
    "is_printed": false,
    "is_locked": false,
    "deadline": null,
    "scheduled_at": "2026-10-12T10:50:00.000000Z",
    "closed_at": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Delivery updated successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Delete delivery

DELETE /admin/api/v1/inventories/deliveries/{id}

Delete a delivery

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The delivery ID

cURLJavaScriptPHPPython

bash

curl -X DELETE "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries/{id}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/inventories/deliveries/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.delete(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "message": "Delivery deleted successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Check delivery availability

POST /admin/api/v1/inventories/deliveries/{id}/check-availability

Compute and refresh delivery availability

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The delivery ID

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/check-availability" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/check-availability", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/check-availability', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/check-availability"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "aut adipisci",
    "origin": null,
    "move_type": "direct",
    "state": "draft",
    "is_favorite": false,
    "description": null,
    "has_deadline_issue": false,
    "is_printed": false,
    "is_locked": false,
    "deadline": null,
    "scheduled_at": "2026-10-12T10:50:00.000000Z",
    "closed_at": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Delivery availability checked successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Mark delivery as todo

POST /admin/api/v1/inventories/deliveries/{id}/todo

Reset delivery allocation status

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The delivery ID

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/todo" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/todo", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/todo', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/todo"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "aut adipisci",
    "origin": null,
    "move_type": "direct",
    "state": "draft",
    "is_favorite": false,
    "description": null,
    "has_deadline_issue": false,
    "is_printed": false,
    "is_locked": false,
    "deadline": null,
    "scheduled_at": "2026-10-12T10:50:00.000000Z",
    "closed_at": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Delivery set to todo successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Validate delivery

POST /admin/api/v1/inventories/deliveries/{id}/validate

Validate delivery and complete stock moves

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The delivery ID

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/validate" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/validate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/validate', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/validate"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "aut adipisci",
    "origin": null,
    "move_type": "direct",
    "state": "draft",
    "is_favorite": false,
    "description": null,
    "has_deadline_issue": false,
    "is_printed": false,
    "is_locked": false,
    "deadline": null,
    "scheduled_at": "2026-10-12T10:50:00.000000Z",
    "closed_at": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Delivery validated successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Cancel delivery

POST /admin/api/v1/inventories/deliveries/{id}/cancel

Cancel delivery and related moves

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The delivery ID

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/cancel" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/cancel', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/cancel"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "aut adipisci",
    "origin": null,
    "move_type": "direct",
    "state": "draft",
    "is_favorite": false,
    "description": null,
    "has_deadline_issue": false,
    "is_printed": false,
    "is_locked": false,
    "deadline": null,
    "scheduled_at": "2026-10-12T10:50:00.000000Z",
    "closed_at": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Delivery canceled successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Return delivery

POST /admin/api/v1/inventories/deliveries/{id}/return

Create a return operation from this delivery

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The delivery ID

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/return" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/return", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/return', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/deliveries/{id}/return"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "aut adipisci",
    "origin": null,
    "move_type": "direct",
    "state": "draft",
    "is_favorite": false,
    "description": null,
    "has_deadline_issue": false,
    "is_printed": false,
    "is_locked": false,
    "deadline": null,
    "scheduled_at": "2026-10-12T10:50:00.000000Z",
    "closed_at": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Delivery return created successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Deliveries ​

List deliveries ​

Create delivery ​

Show delivery ​

Update delivery ​

Delete delivery ​

Check delivery availability ​

Mark delivery as todo ​

Validate delivery ​

Cancel delivery ​

Return delivery ​

Deliveries

List deliveries

Create delivery

Show delivery

Update delivery

Delete delivery

Check delivery availability

Mark delivery as todo

Validate delivery

Cancel delivery

Return delivery