Retorna uma ordem de produção específica buscando pelo código

Respostas

🟢200OK

application/json

Sucesso

Body

success

boolean

opcional

Padrão:

true

message

string

opcional

Padrão:

OP encontrada

response

object

opcional

description

string

opcional

code

integer

requerido

Código único da ordem de produção.

details

string

opcional

Observações.

status

string

opcional

O status se baseia no nome do estágio em que ele se apresenta, por padrão o nome do 1° estágio é adicionado.

stage

string

opcional

Id do estágio onde ele se encontra.

netTotal

number <float>

opcional

Valor total da ordem de produção.

warehouse

string

opcional

Id do depósito em que quando finalizar a ordem de produção a quantidade de itens vai ser acresentado conforme a quantidade solicitada se não for informado o depósito para cada item.

child

string

opcional

Id da empresa filial.

tasks

array[object (po_tasks) {1}]

opcional

dateForeseenIni

string <date>

opcional

Previsão de início.

dateForeseenFinal

string <date>

opcional

Previsão de finalização da ordem de produção.

tags

array[object (item_tags) {1}]

opcional

Id da tag, só pode ser adicionados tags que fazem parte do escopo da ordem de produção.

dateCreated

string <date>

opcional

Data de criação da ordem de produção, já existe no backend a adição da data automaticamente.

sales

array[object (po_sales) {1}]

opcional

Adição dos pedidos na ordem de produção, só pode ser adicionado o pedido se o itemsPO estiver 'false'.

itemsPO

boolean

requerido

Caso habilitado, informa ao sistema que esta ordem de produção é por item e não por pedido.

Padrão:

false

items

array[object (po_items) {5}]

opcional

itemsDone

array[object (po_itemsDone) {3}]

opcional

Quando finalizado a ordem de produção todos os itens são adicionados nesta lista.

events

array[object (po_events) {4}]

opcional

Ocorre quando muda a ordem de produção de estágio.

dateEnd

string <date>

opcional

Data da finalização da ordem de produção.

company

string

opcional

Id da empresa que cadastrou a ordem de produção, já é feito de forma automática por meio do token informado.

user

string

opcional

Id do usuário que cadastrou a ordem de produção, já é feito de forma automática por meio do token informado.

customFields

array[object (po_customFields) {2}]

opcional

updates

array[object (po_updates) {3}]

opcional

As atualizações são adicionadas automaticamente quando é feito alguma mudança na ordem de produção.

userInfo

object

userInfo_userInfo

opcional

Exemplo

{
  "success": true,
  "message": "OP encontrada",
  "response": {
    "description": "string",
    "code": 0,
    "details": "string",
    "status": "string",
    "stage": "string",
    "netTotal": 0,
    "warehouse": "string",
    "child": "string",
    "tasks": [
      {
        "taskId": "string"
      }
    ],
    "dateForeseenIni": "2019-08-24",
    "dateForeseenFinal": "2019-08-24",
    "tags": [
      {
        "tagId": "string"
      }
    ],
    "dateCreated": "2019-08-24",
    "sales": [
      {
        "sale": "string"
      }
    ],
    "itemsPO": false,
    "items": [
      {
        "item": "string",
        "variation": "string",
        "qty": 0,
        "details": "string",
        "price": 0
      }
    ],
    "itemsDone": [
      {
        "item": "string",
        "variation": "string",
        "qty": 0
      }
    ],
    "events": [
      {
        "statusOrig": "string",
        "statusDest": "string",
        "dateEvent": "2019-08-24",
        "user": "string"
      }
    ],
    "dateEnd": "2019-08-24",
    "company": "string",
    "user": "string",
    "customFields": [
      {
        "fieldId": "string",
        "value": "string"
      }
    ],
    "updates": [
      {
        "user": "string",
        "timestamp": "YYYY-MM-DD HH:mm:ss",
        "description": "string"
      }
    ],
    "userInfo": {
      "_id": "string",
      "role": "string",
      "perimisions": [
        "string"
      ],
      "isVerified": true,
      "showBanner": true,
      "priceLists": [
        "string"
      ],
      "allLists": true,
      "email": "user@example.com",
      "name": "string",
      "phone": "string",
      "password": "string",
      "companies": [
        {
          "_id": "string",
          "company": "string"
        }
      ],
      "dateCreated": "YYYY-MM-DD HH:mm:ss",
      "company": "string",
      "__v": 0,
      "api_key": "string"
    }
  }
}

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Retorna uma ordem de produção específica buscando pelo código

Requisição

Exemplos de Requisição

Respostas