Joint

Retrieve an existing order joint

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

idstringOpcional

order_idstringOpcional

external_idstringOpcional

404

OrderJoint was not found

application/json

500

An internal server error was thrown

application/json

get/orders/joint/{id}

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

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

Update an existing order joint

put

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

order_idstringObrigatório

external_idstringObrigatório

Respostas

200

OK

application/json

idstringOpcional

404

OrderJoint was not found

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/orders/joint/{id}

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

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

{
  "id": "text"
}

Remove an existing order joint

delete

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

OK

application/json

objectOpcional

404

OrderJoint was not removed

application/json

500

An internal server error was thrown

application/json

delete/orders/joint/{id}

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

{}

Retrieve a page of order joints

get

Autorizações

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

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

OrderJoint was not found

application/json

500

An internal server error was thrown

application/json

get/orders/joint

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

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

Create a new order joint

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

idstringOpcional

order_idstringObrigatório

external_idstringObrigatório

Respostas

201

OrderJoint created successfully

application/json

idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/orders/joint

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

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

{
  "id": "text"
}