Billing

Creates a product or a bundle in the item catalog.

Required: TypeId (1 Product or 2 Bundle) and Name.

Product only:Sku, PartNumber, Manufacturer, UnitCost.

Bundle only:SubItems (required for a bundle, at least one), ShowSubItemsOnInvoice, ShowSubItemDescriptionsOnInvoice. A bundle’s UnitCost is calculated from its sub-items and can’t be sent directly.

Optional for either type:Number, Description, CategoryId, SubcategoryId, ClientId, LocationId, Vendor, UnitPrice, TaxId, ExternalProductId.

Sending a Product-only field on a Bundle, or a Bundle-only field on a Product, is a 400. A SubItems entry can’t itself be a bundle — bundles can’t nest.

POST

items

Creates a product or a bundle in the item catalog.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/items \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "TypeId": 1,
  "Name": "Managed Workstation - Standard",
  "Number": "<string>",
  "Description": "<string>",
  "CategoryId": 123,
  "SubcategoryId": 123,
  "ClientId": 123,
  "LocationId": 123,
  "Sku": "<string>",
  "PartNumber": "<string>",
  "Manufacturer": "<string>",
  "Vendor": "<string>",
  "UnitCost": 42.5,
  "UnitPrice": 89,
  "TaxId": 123,
  "ExternalProductId": "<string>",
  "SubItems": [
    {
      "ItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Quantity": 2
    }
  ],
  "ShowSubItemsOnInvoice": true,
  "ShowSubItemDescriptionsOnInvoice": true
}
'

import requests

url = "https://api.usw.gorelo.io/v1/items"

payload = {
    "TypeId": 1,
    "Name": "Managed Workstation - Standard",
    "Number": "<string>",
    "Description": "<string>",
    "CategoryId": 123,
    "SubcategoryId": 123,
    "ClientId": 123,
    "LocationId": 123,
    "Sku": "<string>",
    "PartNumber": "<string>",
    "Manufacturer": "<string>",
    "Vendor": "<string>",
    "UnitCost": 42.5,
    "UnitPrice": 89,
    "TaxId": 123,
    "ExternalProductId": "<string>",
    "SubItems": [
        {
            "ItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "Quantity": 2
        }
    ],
    "ShowSubItemsOnInvoice": True,
    "ShowSubItemDescriptionsOnInvoice": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    TypeId: 1,
    Name: 'Managed Workstation - Standard',
    Number: '<string>',
    Description: '<string>',
    CategoryId: 123,
    SubcategoryId: 123,
    ClientId: 123,
    LocationId: 123,
    Sku: '<string>',
    PartNumber: '<string>',
    Manufacturer: '<string>',
    Vendor: '<string>',
    UnitCost: 42.5,
    UnitPrice: 89,
    TaxId: 123,
    ExternalProductId: '<string>',
    SubItems: [{ItemId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', Quantity: 2}],
    ShowSubItemsOnInvoice: true,
    ShowSubItemDescriptionsOnInvoice: true
  })
};

fetch('https://api.usw.gorelo.io/v1/items', 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://api.usw.gorelo.io/v1/items",
  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([
    'TypeId' => 1,
    'Name' => 'Managed Workstation - Standard',
    'Number' => '<string>',
    'Description' => '<string>',
    'CategoryId' => 123,
    'SubcategoryId' => 123,
    'ClientId' => 123,
    'LocationId' => 123,
    'Sku' => '<string>',
    'PartNumber' => '<string>',
    'Manufacturer' => '<string>',
    'Vendor' => '<string>',
    'UnitCost' => 42.5,
    'UnitPrice' => 89,
    'TaxId' => 123,
    'ExternalProductId' => '<string>',
    'SubItems' => [
        [
                'ItemId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'Quantity' => 2
        ]
    ],
    'ShowSubItemsOnInvoice' => true,
    'ShowSubItemDescriptionsOnInvoice' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/items"

	payload := strings.NewReader("{\n  \"TypeId\": 1,\n  \"Name\": \"Managed Workstation - Standard\",\n  \"Number\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"CategoryId\": 123,\n  \"SubcategoryId\": 123,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Sku\": \"<string>\",\n  \"PartNumber\": \"<string>\",\n  \"Manufacturer\": \"<string>\",\n  \"Vendor\": \"<string>\",\n  \"UnitCost\": 42.5,\n  \"UnitPrice\": 89,\n  \"TaxId\": 123,\n  \"ExternalProductId\": \"<string>\",\n  \"SubItems\": [\n    {\n      \"ItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"Quantity\": 2\n    }\n  ],\n  \"ShowSubItemsOnInvoice\": true,\n  \"ShowSubItemDescriptionsOnInvoice\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usw.gorelo.io/v1/items")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TypeId\": 1,\n  \"Name\": \"Managed Workstation - Standard\",\n  \"Number\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"CategoryId\": 123,\n  \"SubcategoryId\": 123,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Sku\": \"<string>\",\n  \"PartNumber\": \"<string>\",\n  \"Manufacturer\": \"<string>\",\n  \"Vendor\": \"<string>\",\n  \"UnitCost\": 42.5,\n  \"UnitPrice\": 89,\n  \"TaxId\": 123,\n  \"ExternalProductId\": \"<string>\",\n  \"SubItems\": [\n    {\n      \"ItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"Quantity\": 2\n    }\n  ],\n  \"ShowSubItemsOnInvoice\": true,\n  \"ShowSubItemDescriptionsOnInvoice\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"TypeId\": 1,\n  \"Name\": \"Managed Workstation - Standard\",\n  \"Number\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"CategoryId\": 123,\n  \"SubcategoryId\": 123,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Sku\": \"<string>\",\n  \"PartNumber\": \"<string>\",\n  \"Manufacturer\": \"<string>\",\n  \"Vendor\": \"<string>\",\n  \"UnitCost\": 42.5,\n  \"UnitPrice\": 89,\n  \"TaxId\": 123,\n  \"ExternalProductId\": \"<string>\",\n  \"SubItems\": [\n    {\n      \"ItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"Quantity\": 2\n    }\n  ],\n  \"ShowSubItemsOnInvoice\": true,\n  \"ShowSubItemDescriptionsOnInvoice\": true\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Autoritzacions

X-API-Key

string

header

requerit

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Cos

The item to create.

Creates a product or a bundle in the catalog. TypeId decides which, and which of the type-conditional fields below are accepted.

TypeId

integer<int32>

Whether this is a product (1) or a bundle (2). Required; cannot be changed once created.

Exemple:

1

Name

string

Display name of the item. Required.

Exemple:

"Managed Workstation - Standard"

Number

string | null

The item's product number, free text.

Description

string | null

Free-text description.

CategoryId

integer<int64> | null

Category to file the item under, from GET /v1/items/categories. Validated for existence and tenant ownership.

SubcategoryId

integer<int64> | null

Subcategory to file the item under; must belong to CategoryId.

ClientId

integer<int64> | null

Client this item is scoped to, when it is client-specific rather than catalog-wide.

LocationId

integer<int64> | null

Client location this item is scoped to; must belong to ClientId.

Sku

string | null

Product-only. Rejected (400) if sent while TypeId is Bundle.

PartNumber

string | null

Product-only. Rejected (400) if sent while TypeId is Bundle.

Manufacturer

string | null

Product-only. Rejected (400) if sent while TypeId is Bundle.

Vendor

string | null

Vendor the item is sourced from.

UnitCost

number<double> | null

Product-only. Rejected (400) if sent while TypeId is Bundle — a bundle's cost is derived server-side from its sub-items, never supplied directly.

Exemple:

42.5

UnitPrice

number<double> | null

Unit price charged to the client. May be negative, for a discount or credit line.

Exemple:

89

TaxId

integer<int64> | null

Tax rate to apply, from GET /v1/taxes.

ExternalProductId

string | null

Identifier of this item in an external accounting system.

SubItems

object[] | null

Bundle-only, required for a bundle (at least one entry) — rejected (400) if sent while TypeId is Product. Every ItemId must resolve to an existing, active product (not a bundle — bundles cannot nest) owned by this service provider.

Show child attributes

ShowSubItemsOnInvoice

boolean | null

Bundle-only. Rejected (400) if sent while TypeId is Product.

ShowSubItemDescriptionsOnInvoice

boolean | null

Bundle-only. Rejected (400) if sent while TypeId is Product.

Resposta

StatusCode

enum<integer>

Opcions disponibles:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

Result of a create-item request. Matches the minimal shape returned by create-ticket, create-time-entry and create-invoice, rather than returning the full item.

Show child attributes

DataContext

object | null

Exemple:

null

Notifications

object[]

Show child attributes

⌘I

Creates a product or a bundle in the item catalog.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/items \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "TypeId": 1,
  "Name": "Managed Workstation - Standard",
  "Number": "<string>",
  "Description": "<string>",
  "CategoryId": 123,
  "SubcategoryId": 123,
  "ClientId": 123,
  "LocationId": 123,
  "Sku": "<string>",
  "PartNumber": "<string>",
  "Manufacturer": "<string>",
  "Vendor": "<string>",
  "UnitCost": 42.5,
  "UnitPrice": 89,
  "TaxId": 123,
  "ExternalProductId": "<string>",
  "SubItems": [
    {
      "ItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Quantity": 2
    }
  ],
  "ShowSubItemsOnInvoice": true,
  "ShowSubItemDescriptionsOnInvoice": true
}
'

import requests

url = "https://api.usw.gorelo.io/v1/items"

payload = {
    "TypeId": 1,
    "Name": "Managed Workstation - Standard",
    "Number": "<string>",
    "Description": "<string>",
    "CategoryId": 123,
    "SubcategoryId": 123,
    "ClientId": 123,
    "LocationId": 123,
    "Sku": "<string>",
    "PartNumber": "<string>",
    "Manufacturer": "<string>",
    "Vendor": "<string>",
    "UnitCost": 42.5,
    "UnitPrice": 89,
    "TaxId": 123,
    "ExternalProductId": "<string>",
    "SubItems": [
        {
            "ItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "Quantity": 2
        }
    ],
    "ShowSubItemsOnInvoice": True,
    "ShowSubItemDescriptionsOnInvoice": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    TypeId: 1,
    Name: 'Managed Workstation - Standard',
    Number: '<string>',
    Description: '<string>',
    CategoryId: 123,
    SubcategoryId: 123,
    ClientId: 123,
    LocationId: 123,
    Sku: '<string>',
    PartNumber: '<string>',
    Manufacturer: '<string>',
    Vendor: '<string>',
    UnitCost: 42.5,
    UnitPrice: 89,
    TaxId: 123,
    ExternalProductId: '<string>',
    SubItems: [{ItemId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', Quantity: 2}],
    ShowSubItemsOnInvoice: true,
    ShowSubItemDescriptionsOnInvoice: true
  })
};

fetch('https://api.usw.gorelo.io/v1/items', 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://api.usw.gorelo.io/v1/items",
  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([
    'TypeId' => 1,
    'Name' => 'Managed Workstation - Standard',
    'Number' => '<string>',
    'Description' => '<string>',
    'CategoryId' => 123,
    'SubcategoryId' => 123,
    'ClientId' => 123,
    'LocationId' => 123,
    'Sku' => '<string>',
    'PartNumber' => '<string>',
    'Manufacturer' => '<string>',
    'Vendor' => '<string>',
    'UnitCost' => 42.5,
    'UnitPrice' => 89,
    'TaxId' => 123,
    'ExternalProductId' => '<string>',
    'SubItems' => [
        [
                'ItemId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'Quantity' => 2
        ]
    ],
    'ShowSubItemsOnInvoice' => true,
    'ShowSubItemDescriptionsOnInvoice' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/items"

	payload := strings.NewReader("{\n  \"TypeId\": 1,\n  \"Name\": \"Managed Workstation - Standard\",\n  \"Number\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"CategoryId\": 123,\n  \"SubcategoryId\": 123,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Sku\": \"<string>\",\n  \"PartNumber\": \"<string>\",\n  \"Manufacturer\": \"<string>\",\n  \"Vendor\": \"<string>\",\n  \"UnitCost\": 42.5,\n  \"UnitPrice\": 89,\n  \"TaxId\": 123,\n  \"ExternalProductId\": \"<string>\",\n  \"SubItems\": [\n    {\n      \"ItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"Quantity\": 2\n    }\n  ],\n  \"ShowSubItemsOnInvoice\": true,\n  \"ShowSubItemDescriptionsOnInvoice\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usw.gorelo.io/v1/items")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TypeId\": 1,\n  \"Name\": \"Managed Workstation - Standard\",\n  \"Number\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"CategoryId\": 123,\n  \"SubcategoryId\": 123,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Sku\": \"<string>\",\n  \"PartNumber\": \"<string>\",\n  \"Manufacturer\": \"<string>\",\n  \"Vendor\": \"<string>\",\n  \"UnitCost\": 42.5,\n  \"UnitPrice\": 89,\n  \"TaxId\": 123,\n  \"ExternalProductId\": \"<string>\",\n  \"SubItems\": [\n    {\n      \"ItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"Quantity\": 2\n    }\n  ],\n  \"ShowSubItemsOnInvoice\": true,\n  \"ShowSubItemDescriptionsOnInvoice\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"TypeId\": 1,\n  \"Name\": \"Managed Workstation - Standard\",\n  \"Number\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"CategoryId\": 123,\n  \"SubcategoryId\": 123,\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"Sku\": \"<string>\",\n  \"PartNumber\": \"<string>\",\n  \"Manufacturer\": \"<string>\",\n  \"Vendor\": \"<string>\",\n  \"UnitCost\": 42.5,\n  \"UnitPrice\": 89,\n  \"TaxId\": 123,\n  \"ExternalProductId\": \"<string>\",\n  \"SubItems\": [\n    {\n      \"ItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"Quantity\": 2\n    }\n  ],\n  \"ShowSubItemsOnInvoice\": true,\n  \"ShowSubItemDescriptionsOnInvoice\": true\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}