Sellers

Retrieve seller given an ID

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

Seller was not found

application/json

500

An internal server error was thrown

application/json

get

/sellers/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "seller_type": "text",
  "fiscal_registration_number": "text",
  "email": "text",
  "phone": "text",
  "mobile": "text",
  "active": true,
  "max_increase_rate": 1,
  "max_discount_rate": 1,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update an existing seller

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

seller_typestringObrigatório

fiscal_registration_numberstringObrigatório

emailstringObrigatório

phonestringObrigatório

mobilestringObrigatório

activebooleanObrigatório

max_increase_ratenumberObrigatório

max_discount_ratenumberObrigatório

Respostas

200

Seller updated successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

/sellers/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "seller_type": "text",
  "fiscal_registration_number": "text",
  "email": "text",
  "phone": "text",
  "mobile": "text",
  "active": true,
  "max_increase_rate": 1,
  "max_discount_rate": 1,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "seller_type": "text",
  "fiscal_registration_number": "text",
  "email": "text",
  "phone": "text",
  "mobile": "text",
  "active": true,
  "max_increase_rate": 1,
  "max_discount_rate": 1,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Remove an existing seller

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

Seller removed successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete

/sellers/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text"
}

List all sellers

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

only_activebooleanOpcional

Respostas

200

OK

application/json

404

Seller was not found

application/json

500

An internal server error was thrown

application/json

get

/sellers

HTTPcURLJavaScriptPython

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

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "seller_type": "text",
      "fiscal_registration_number": "text",
      "email": "text",
      "phone": "text",
      "mobile": "text",
      "active": true,
      "max_increase_rate": 1,
      "max_discount_rate": 1,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Create a new seller

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

seller_typestringObrigatório

fiscal_registration_numberstringObrigatório

emailstringObrigatório

phonestringObrigatório

mobilestringObrigatório

activebooleanObrigatório

max_increase_ratenumberObrigatório

max_discount_ratenumberObrigatório

Respostas

201

Seller created successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/sellers

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "seller_type": "text",
  "fiscal_registration_number": "text",
  "email": "text",
  "phone": "text",
  "mobile": "text",
  "active": true,
  "max_increase_rate": 1,
  "max_discount_rate": 1,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "seller_type": "text",
  "fiscal_registration_number": "text",
  "email": "text",
  "phone": "text",
  "mobile": "text",
  "active": true,
  "max_increase_rate": 1,
  "max_discount_rate": 1,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}