Create operation type

POST

admin

api

inventories

operation-types

Create operation type

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/inventories/operation-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Receipts",
  "type": "incoming",
  "sequence_code": "IN",
  "create_backorder": "ask",
  "source_location_id": 1,
  "destination_location_id": 2
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/inventories/operation-types"

payload = {
    "name": "Receipts",
    "type": "incoming",
    "sequence_code": "IN",
    "create_backorder": "ask",
    "source_location_id": 1,
    "destination_location_id": 2
}
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: 'Receipts',
    type: 'incoming',
    sequence_code: 'IN',
    create_backorder: 'ask',
    source_location_id: 1,
    destination_location_id: 2
  })
};

fetch('https://erp.arukz.com/admin/api/v1/inventories/operation-types', 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/operation-types",
  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' => 'Receipts',
    'type' => 'incoming',
    'sequence_code' => 'IN',
    'create_backorder' => 'ask',
    'source_location_id' => 1,
    'destination_location_id' => 2
  ]),
  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": "Receipts",
    "type": "incoming",
    "sort": 1,
    "sequence_code": "IN",
    "reservation_method": "at_confirm",
    "reservation_days_before": 0,
    "reservation_days_before_priority": 0,
    "product_label_format": "2x7xprice",
    "lot_label_format": "4x12_lots",
    "package_label_to_print": "pdf",
    "barcode": "WHIN",
    "create_backorder": "ask",
    "move_type": "direct",
    "show_entire_packs": false,
    "use_create_lots": true,
    "use_existing_lots": true,
    "print_label": false,
    "show_operations": false,
    "auto_show_reception_report": false,
    "auto_print_delivery_slip": false,
    "auto_print_return_slip": false,
    "auto_print_product_labels": false,
    "auto_print_lot_labels": false,
    "auto_print_reception_report": false,
    "auto_print_reception_report_labels": false,
    "auto_print_packages": false,
    "auto_print_package_label": false,
    "created_at": "2025-04-07T13:12:33.000000Z",
    "updated_at": "2025-04-07T13:12:33.000000Z",
    "deleted_at": null
  },
  "message": "Operation type 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

Operation type name. Must not be greater than 255 characters.

Example:

"Receipts"

type

enum<string>

required

Operation type value.

Available options:

incoming,

outgoing,

internal,

dropship

Example:

"incoming"

sequence_code

string

required

Sequence prefix. Must not be greater than 255 characters.

Example:

"IN"

create_backorder

enum<string>

required

Backorder policy.

Available options:

ask,

always,

never

Example:

"ask"

source_location_id

integer

required

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

Example:

1

destination_location_id

integer

required

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

Example:

2

print_label

boolean | null

Generate shipping labels.

Example:

false

warehouse_id

integer | null

Warehouse ID. The id of an existing record in the inventories_warehouses table.

Example:

1

reservation_method

enum<string> | null

Reservation method.

Available options:

at_confirm,

manual,

by_date

Example:

"at_confirm"

auto_show_reception_report

boolean | null

Auto show reception report.

Example:

false

company_id

integer | null

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

Example:

1

return_operation_type_id

integer | null

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

Example:

2

move_type

enum<string> | null

Shipping policy.

Available options:

direct,

one

Example:

"direct"

use_create_lots

boolean | null

Allow creating new lots.

Example:

false

use_existing_lots

boolean | null

Allow selecting existing lots.

Example:

false

Response

Created

⌘I

Create operation type

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/inventories/operation-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Receipts",
  "type": "incoming",
  "sequence_code": "IN",
  "create_backorder": "ask",
  "source_location_id": 1,
  "destination_location_id": 2
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/inventories/operation-types"

payload = {
    "name": "Receipts",
    "type": "incoming",
    "sequence_code": "IN",
    "create_backorder": "ask",
    "source_location_id": 1,
    "destination_location_id": 2
}
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: 'Receipts',
    type: 'incoming',
    sequence_code: 'IN',
    create_backorder: 'ask',
    source_location_id: 1,
    destination_location_id: 2
  })
};

fetch('https://erp.arukz.com/admin/api/v1/inventories/operation-types', 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/operation-types",
  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' => 'Receipts',
    'type' => 'incoming',
    'sequence_code' => 'IN',
    'create_backorder' => 'ask',
    'source_location_id' => 1,
    'destination_location_id' => 2
  ]),
  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": "Receipts",
    "type": "incoming",
    "sort": 1,
    "sequence_code": "IN",
    "reservation_method": "at_confirm",
    "reservation_days_before": 0,
    "reservation_days_before_priority": 0,
    "product_label_format": "2x7xprice",
    "lot_label_format": "4x12_lots",
    "package_label_to_print": "pdf",
    "barcode": "WHIN",
    "create_backorder": "ask",
    "move_type": "direct",
    "show_entire_packs": false,
    "use_create_lots": true,
    "use_existing_lots": true,
    "print_label": false,
    "show_operations": false,
    "auto_show_reception_report": false,
    "auto_print_delivery_slip": false,
    "auto_print_return_slip": false,
    "auto_print_product_labels": false,
    "auto_print_lot_labels": false,
    "auto_print_reception_report": false,
    "auto_print_reception_report_labels": false,
    "auto_print_packages": false,
    "auto_print_package_label": false,
    "created_at": "2025-04-07T13:12:33.000000Z",
    "updated_at": "2025-04-07T13:12:33.000000Z",
    "deleted_at": null
  },
  "message": "Operation type created successfully."
}

{
  "message": "Unauthenticated."
}

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

Get started

Endpoints

Authorizations

Body

Response