Warehouses

Obter Local

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 rota

idstringObrigatório

Respostas

200

OK

application/json

404

Warehouse was not found

application/json

500

An internal server error was thrown

application/json

get

/warehouses/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Atualizar Local

put

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

Corpo

application/json

namestringObrigatório

address_typestringObrigatório

streetstringObrigatório

numberstringObrigatório

complementstringObrigatório

neighborhoodstringObrigatório

citystringObrigatório

statestringObrigatório

countrystringObrigatório

activebooleanObrigatório

postal_codestringObrigatório

Respostas

200

Warehouse updated successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

/warehouses/{id}

HTTPcURLJavaScriptPython

PUT /api/sales/warehouses/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Remover Local

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

Warehouse removed successfully

application/json

422

A validation error was thrown

500

An internal server error was thrown

delete

/warehouses/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text"
}

Listar Locais

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

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

404

Warehouse was not found

application/json

500

An internal server error was thrown

application/json

get

/warehouses

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Criar Local

post

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idstringOpcional

namestringObrigatório

address_typestringObrigatório

streetstringObrigatório

numberstringObrigatório

complementstringObrigatório

neighborhoodstringObrigatório

citystringObrigatório

statestringObrigatório

countrystringObrigatório

activebooleanObrigatório

postal_codestringObrigatório

Respostas

201

Warehouse created successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/warehouses

HTTPcURLJavaScriptPython

POST /api/sales/warehouses HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}