Products & Services

All API Operations related with products & services

READ Scope

List all Products & Services

Retrieves all the products and services

get

/v1/product-services

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/product-services' \
  --header 'Authorization: YOUR_API_KEY'

200

200

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

OK

Get a Product / Service by ID

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

get

/v1/product-services/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/product-services/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

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

OK

WRITE Scope

Create a new Product or Service

Creates a new product or service

post

/v1/product-services

Authorizations

Body

application/jsontext/jsonapplication/*+json

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.nuvio.io/v1/product-services' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "productCode": "text",
    "taxes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

200

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

OK

UPDATE Scope

Update Product or Service

Updates an existing product or service

put

/v1/product-services/{id}

Authorizations

Path parameters

idstring · uuidrequired

Body

application/jsontext/jsonapplication/*+json

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.nuvio.io/v1/product-services/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "productCode": "text",
    "taxes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

200

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

OK