Products & Services

All API Operations related with products & services

READ Scope

List all Products & Services

Retrieves all the products and services

GEThttps://api.nuvio.io/v1/product-services

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataarray of Products

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/product-services', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "name": "text",
      "taxes": [
        {
          "taxId": "123e4567-e89b-12d3-a456-426614174000",
          "taxName": "text"
        }
      ]
    }
  ]
}

Get a Product / Service by ID

Retrieves a single product or service by its unique ID or user-generated product code.

GEThttps://api.nuvio.io/v1/product-services/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataProduct

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/product-services/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "taxes": [
      {
        "taxId": "123e4567-e89b-12d3-a456-426614174000",
        "taxName": "text"
      }
    ]
  }
}

WRITE Scope

Create a new Product or Service

Creates a new product or service

POSThttps://api.nuvio.io/v1/product-services

Body

application/jsontext/jsonapplication/*+json

name*string

A user-generated custom code for this product or service

productCodestring

Name of the product or service

taxesarray of string (uuid)

A list of the default taxes to be added to when the product is selected in the Nuvio Platform. Provide a list of taxes with their 32-character unique ID.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataProduct

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/product-services', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "taxes": [
      {
        "taxId": "123e4567-e89b-12d3-a456-426614174000",
        "taxName": "text"
      }
    ]
  }
}

UPDATE Scope

Update Product or Service

Updates an existing product or service

PUThttps://api.nuvio.io/v1/product-services/{id}

Path parameters

id*string (uuid)

Body

application/jsontext/jsonapplication/*+json

namestring

A user-generated custom code for this product or service

productCodestring

Name of the product or service

taxesarray of string (uuid)

A list of the default taxes to be added to when the product is selected in the Nuvio Platform. Provide a list of taxes with their 32-character unique ID.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataProduct

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/product-services/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "taxes": [
      {
        "taxId": "123e4567-e89b-12d3-a456-426614174000",
        "taxName": "text"
      }
    ]
  }
}