Create rule - ARUKZ ERP Docs

POST

/

admin

/

api

/

v1

/

inventories

/

rules

Create rule

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/inventories/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "WH1: Stock -> Output",
  "action": "pull",
  "operation_type_id": 1,
  "source_location_id": 3,
  "destination_location_id": 4,
  "route_id": 1
}
'

import requests

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

payload = {
    "name": "WH1: Stock -> Output",
    "action": "pull",
    "operation_type_id": 1,
    "source_location_id": 3,
    "destination_location_id": 4,
    "route_id": 1
}
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({
    name: 'WH1: Stock -> Output',
    action: 'pull',
    operation_type_id: 1,
    source_location_id: 3,
    destination_location_id: 4,
    route_id: 1
  })
};

fetch('https://erp.arukz.com/admin/api/v1/inventories/rules', 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/rules",
  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([
    'name' => 'WH1: Stock -> Output',
    'action' => 'pull',
    'operation_type_id' => 1,
    'source_location_id' => 3,
    'destination_location_id' => 4,
    'route_id' => 1
  ]),
  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: Vendors → Stock",
    "sort": 1,
    "route_sort": 9,
    "delay": 0,
    "group_propagation_option": "propagate",
    "action": "pull",
    "procure_method": "make_to_stock",
    "auto": "manual",
    "push_domain": null,
    "location_dest_from_rule": false,
    "propagate_cancel": false,
    "propagate_carrier": false,
    "created_at": "2025-04-07T13:12:33.000000Z",
    "updated_at": "2025-04-07T13:12:33.000000Z",
    "deleted_at": null
  },
  "message": "Rule created successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name 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

name

string

required

Rule name. Must not be greater than 255 characters.

Example:

"WH1: Stock -> Output"

action

enum<string>

required

Rule action.

Available options:

pull,

push,

pull_push,

buy

Example:

"pull"

operation_type_id

integer

required

Operation type ID. The id of an existing record in the inventories_operation_types table.

Example:

1

source_location_id

integer

required

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

Example:

3

destination_location_id

integer

required

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

Example:

4

route_id

integer

required

Route ID. The id of an existing record in the inventories_routes table.

Example:

1

partner_address_id

integer | null

Partner address ID. The id of an existing record in the partners_partners table.

Example:

10

delay

integer | null

Lead time in days. Must be at least 0.

Example:

1

company_id

integer | null

Company ID. The id of an existing record in the companies table.

Example:

1

Response

Created

⌘I

Create rule

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/inventories/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "WH1: Stock -> Output",
  "action": "pull",
  "operation_type_id": 1,
  "source_location_id": 3,
  "destination_location_id": 4,
  "route_id": 1
}
'

import requests

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

payload = {
    "name": "WH1: Stock -> Output",
    "action": "pull",
    "operation_type_id": 1,
    "source_location_id": 3,
    "destination_location_id": 4,
    "route_id": 1
}
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({
    name: 'WH1: Stock -> Output',
    action: 'pull',
    operation_type_id: 1,
    source_location_id: 3,
    destination_location_id: 4,
    route_id: 1
  })
};

fetch('https://erp.arukz.com/admin/api/v1/inventories/rules', 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/rules",
  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([
    'name' => 'WH1: Stock -> Output',
    'action' => 'pull',
    'operation_type_id' => 1,
    'source_location_id' => 3,
    'destination_location_id' => 4,
    'route_id' => 1
  ]),
  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: Vendors → Stock",
    "sort": 1,
    "route_sort": 9,
    "delay": 0,
    "group_propagation_option": "propagate",
    "action": "pull",
    "procure_method": "make_to_stock",
    "auto": "manual",
    "push_domain": null,
    "location_dest_from_rule": false,
    "propagate_cancel": false,
    "propagate_carrier": false,
    "created_at": "2025-04-07T13:12:33.000000Z",
    "updated_at": "2025-04-07T13:12:33.000000Z",
    "deleted_at": null
  },
  "message": "Rule created successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}