Products & Services

All API Operations related with products & services

READ Scope

List all Products & Services

get

Retrieves all the products and services

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

get

/v1/product-services

HTTPcURLJavaScriptPython

GET /v1/product-services HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "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

get

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

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Path parameters

idstringRequired

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

get

/v1/product-services/{id}

HTTPcURLJavaScriptPython

GET /v1/product-services/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "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

post

Creates a new product or service

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Body

application/jsontext/jsonapplication/*+json

namestring · min: 1Required

A user-generated custom code for this product or service

productCodestringOptional

Name of the product or service

taxesstring · uuid[]Optional

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.

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

post

/v1/product-services

HTTPcURLJavaScriptPython

POST /v1/product-services HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "name": "text",
  "productCode": "text",
  "taxes": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "success": true,
  "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

put

Updates an existing product or service

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Path parameters

idstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

namestringOptional

A user-generated custom code for this product or service

productCodestringOptional

Name of the product or service

taxesstring · uuid[]Optional

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.

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

put

/v1/product-services/{id}

HTTPcURLJavaScriptPython

PUT /v1/product-services/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "name": "text",
  "productCode": "text",
  "taxes": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

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