Create delivery - ARUKZ ERP Docs

POST

/

admin

/

api

/

v1

/

inventories

/

deliveries

Create delivery

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/inventories/deliveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://erp.arukz.com/admin/api/v1/inventories/deliveries"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://erp.arukz.com/admin/api/v1/inventories/deliveries', 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://erp.arukz.com/admin/api/v1/inventories/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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;
}

{
  "data": {
    "id": 1,
    "name": "WH/INT/1",
    "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": "2025-04-10T12:10:18.000000Z",
    "closed_at": null,
    "created_at": "2025-04-10T12:11:32.000000Z",
    "updated_at": "2025-04-10T12:11:32.000000Z"
  },
  "message": "Delivery created successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "moves.0.product_id": [
      "The moves.0.product id field is required."
    ]
  }
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Body

application/json

partner_id

integer | null

Partner ID (receive from, contact, or delivery address based on operation type). The id of an existing record in the partners_partners table.

Example:

1

operation_type_id

integer | null

Operation type ID. If omitted, the API resolves the default operation type for the resource. The id of an existing record in the inventories_operation_types table.

Example:

1

source_location_id

integer | null

Source location ID. The id of an existing record in the inventories_locations table.

Example:

1

destination_location_id

integer | null

Destination location ID. The id of an existing record in the inventories_locations table.

Example:

2

user_id

integer | null

Responsible user ID. The id of an existing record in the users table.

Example:

1

move_type

enum<string> | null

Shipping policy.

Available options:

direct,

one

Example:

"direct"

scheduled_at

string | null

Scheduled datetime. Must be a valid date.

Example:

"2026-02-25 10:00:00"

origin

string | null

Source document reference. Must not be greater than 255 characters.

Example:

"SO/00001"

description

string | null

Operation note.

Example:

"Handle with care."

moves

object[] | null

Optional operation moves payload.

Show child attributes

Example:

[
  {
    "product_id": 1,
    "product_uom_qty": 5,
    "uom_id": 1,
    "quantity": 0,
    "is_picked": false
  }
]

Response

Created

⌘I

Create delivery

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/inventories/deliveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://erp.arukz.com/admin/api/v1/inventories/deliveries"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://erp.arukz.com/admin/api/v1/inventories/deliveries', 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://erp.arukz.com/admin/api/v1/inventories/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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;
}

{
  "data": {
    "id": 1,
    "name": "WH/INT/1",
    "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": "2025-04-10T12:10:18.000000Z",
    "closed_at": null,
    "created_at": "2025-04-10T12:11:32.000000Z",
    "updated_at": "2025-04-10T12:11:32.000000Z"
  },
  "message": "Delivery created successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "moves.0.product_id": [
      "The moves.0.product id field is required."
    ]
  }
}