⚡
Zydon
Uptime serviços Zydon
  • Bem-vindo à Zydon
  • Quickstart
    • Chaves de acesso
    • Autenticação
  • Cadastros Gerais
    • Profiles
      • Import
      • Get import spreadsheet
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Companies
      • Import
      • Get import spreadsheet
    • Resource files
      • Details
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
  • Produtos
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Prices
      • Product
        • Calculate
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Discounts
      • Products
    • Price tables
      • Copy
      • Products
    • Warehouses
      • Import
      • Get import spreadsheet
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Portal User Search
      • User
        • Search
  • Pedidos
    • Payment groups
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Status
    • Coupons
      • Manual
      • Automatic
    • Sales
      • Statuses
        • Available
  • Financeiro
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
  • Webhooks
    • Sincronização de dados
    • Envio de Pedido
    • Cadastro de Parceiro
  • About
  • API reference
    • Warehouses
      • Import
      • Get import spreadsheet
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Status
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Profiles
      • Import
      • Get import spreadsheet
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Price tables
      • Copy
      • Products
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Payment groups
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
    • Discounts
      • Products
    • Coupons
      • Manual
      • Automatic
    • Companies
      • Import
      • Get import spreadsheet
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Sales
      • Statuses
        • Available
    • Resource files
      • Details
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Sales funnel
    • Template
      • Validate
      • Install
      • Export
    • Home
      • Sales
      • Sales by period
      • Products
      • Users
    • Prices
      • Product
        • Calculate
  • Specification
  • About
  • Specification
Fornecido por GitBook
Nesta página
  1. Cadastros Gerais
  2. Partners

Address

Retrieve a PartnerAddress given an ID

get
Autorizações
Parâmetros de rota
partner_idstringObrigatório
idstringObrigatório
Respostas
200
OK
application/json
404
PartnerAddress was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/partners/{partner_id}/address/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}

Remove a PartnerAddress given an ID

delete
Autorizações
Parâmetros de rota
partner_idstringObrigatório
idstringObrigatório
Respostas
204
Partner removed successfully
application/json
Respostaobject
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
delete
DELETE /api/sales/partners/{partner_id}/address/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{}
  • GETList all addresses given an partner ID
  • POSTCreate a new partner address
  • PUTUpdate an existing partner address
  • GETRetrieve a PartnerAddress given an ID
  • DELETERemove a PartnerAddress given an ID

List all addresses given an partner ID

get
Autorizações
Parâmetros de rota
partner_idstringObrigatório
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: mainAddress
dirstringOpcionalDefault: desc
Respostas
200
OK
application/json
404
PartnerAddress was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "partner_id": "text",
      "name": "text",
      "address_type": "text",
      "street": "text",
      "number": "text",
      "complement": "text",
      "contact_number": "text",
      "contact_name": "text",
      "neighborhood": "text",
      "state": "text",
      "country": "text",
      "city": "text",
      "postal_code": "text",
      "main_address": true
    }
  ]
}

Create a new partner address

post
Autorizações
Parâmetros de rota
partner_idstringObrigatório
Corpo
idstringOpcional
namestringOpcional
address_typestringOpcional
streetstringOpcional
numberstringOpcional
complementstringOpcional
contact_numberstringOpcional
contact_namestringOpcional
neighborhoodstringOpcional
statestringOpcional
countrystringOpcional
citystringOpcional
postal_codestringOpcional
main_addressbooleanOpcional
Respostas
201
PartnerAddress created successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
post
POST /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}
{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}

Update an existing partner address

put
Autorizações
Parâmetros de rota
partner_idstringObrigatório
Corpo
idstringOpcional
namestringOpcional
address_typestringOpcional
streetstringOpcional
numberstringOpcional
complementstringOpcional
contact_numberstringOpcional
contact_namestringOpcional
neighborhoodstringOpcional
statestringOpcional
countrystringOpcional
citystringOpcional
postal_codestringOpcional
main_addressbooleanOpcional
Respostas
200
PartnerAddress updated successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
put
PUT /api/sales/partners/{partner_id}/address HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}
{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "contact_number": "text",
  "contact_name": "text",
  "neighborhood": "text",
  "state": "text",
  "country": "text",
  "city": "text",
  "postal_code": "text",
  "main_address": true
}