Sellers

Retrieve seller given an ID

get

/sellers/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.zydon.com.br/api/sales/sellers/{id}' \
  --header 'Authorization: Bearer JWT'

200

404

500

{
  "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

/sellers/{id}

Authorizations

Path parameters

idstringrequired

Body

namestringrequired

seller_typestringrequired

fiscal_registration_numberstringrequired

emailstringrequired

phonestringrequired

mobilestringrequired

activebooleanrequired

max_increase_ratenumberrequired

max_discount_ratenumberrequired

attributesobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.zydon.com.br/api/sales/sellers/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"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":{}}}'

200

422

500

{
  "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": {}
  }
}

Seller updated successfully

Remove an existing seller

delete

/sellers/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.zydon.com.br/api/sales/sellers/{id}' \
  --header 'Authorization: Bearer JWT'

204

422

500

{
  "id": "text"
}

Seller removed successfully

List all sellers

get

/sellers

Authorizations

Query parameters

searchstring

pageinteger int32

perPageinteger int32

sortstring

dirstring

only_activeboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.zydon.com.br/api/sales/sellers' \
  --header 'Authorization: Bearer JWT'

200

404

500

{
  "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

/sellers

Authorizations

Body

idstring

namestringrequired

seller_typestringrequired

fiscal_registration_numberstringrequired

emailstringrequired

phonestringrequired

mobilestringrequired

activebooleanrequired

max_increase_ratenumberrequired

max_discount_ratenumberrequired

attributesobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.zydon.com.br/api/sales/sellers' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"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":{}}}'

201

422

500

{
  "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": {}
  }
}

Seller created successfully