Stock

Retrieve a page of stock data given a filter

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

company_idstringOpcional

warehouse_idstringOpcional

product_idstringOpcional

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

404

Stock was not found

application/json

500

An internal server error was thrown

application/json

get

/stock

HTTPcURLJavaScriptPython

GET /api/sales/stock HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "company": {
        "id": "text",
        "name": "text",
        "fiscal_registration_number": "text"
      },
      "warehouse": {
        "id": "text",
        "name": "text"
      },
      "product": {
        "id": "text",
        "name": "text",
        "sku": "text"
      },
      "active": true,
      "total": 1,
      "available": 1,
      "reserved": 1
    }
  ]
}

Remove a stock inventory

delete

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

OK

application/json

404

Stock inventory was not found

application/json

500

An internal server error was thrown

application/json

delete

/stock/{id}

HTTPcURLJavaScriptPython

DELETE /api/sales/stock/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}