Joint

Retrieve an existing order joint

GEThttps://api.zydon.com.br/api/sales/orders/joint/{id}

Authorization

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

Path parameters

id*string

Response

200404500

OK

Body

application/json

idstring

order_idstring

external_idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/orders/joint/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "id": "text",
  "order_id": "text",
  "external_id": "text"
}

Update an existing order joint

PUThttps://api.zydon.com.br/api/sales/orders/joint/{id}

Authorization

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

Path parameters

id*string

Body

application/json

order_id*string

external_id*string

Response

200404422500

OK

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/orders/joint/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "external_id": "text",
      "order_id": "text"
    }),
});
const data = await response.json();

Response

200404422500

{
  "id": "text"
}

Remove an existing order joint

DELETEhttps://api.zydon.com.br/api/sales/orders/joint/{id}

Authorization

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

Path parameters

id*string

Response

204404500

OK

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/orders/joint/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Retrieve a page of order joints

GEThttps://api.zydon.com.br/api/sales/orders/joint

Authorization

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

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListOrderJointResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/orders/joint', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "order_id": "text",
      "external_id": "text"
    }
  ]
}

Create a new order joint

POSThttps://api.zydon.com.br/api/sales/orders/joint

Authorization

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

Body

application/json

idstring

order_id*string

external_id*string

Response

201422500

OrderJoint created successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/orders/joint', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "external_id": "text",
      "order_id": "text"
    }),
});
const data = await response.json();

Response

201422500

{
  "id": "text"
}