Criar uma OP - Sensio API

Cria uma Ordem de Produção.

Uma OP pode ser por vendas ou por itens, isso vai depender dos arrays sales e items. Se for passado o array items, será por itens. Do contrário, será por vendas e o array sales precisa ser passado.

Requisição

Parâmetros Bodyapplication/json

description

string

opcional

sales

array [object {1}]

opcional

sale

string

requerido

_id da venda

items

array [object {3}]

opcional

item

string

requerido

_id do item

variation

string

opcional

_id da variação caso o item tenha variações

qty

number

requerido

quantidade a ser produzida

details

string

opcional

observações

dateForeseenIni

string

opcional

data de previsão de início

dateForeseenFinal

string

opcional

data de previsão de final

tags

array [object {1}]

opcional

tagId

string

requerido

_id da tag

customFields

array [object {2}]

opcional

fieldId

string

requerido

_id do custom field

value

string

requerido

valor do custom field

Exemplo

{
    "description": "string",
    "sales": [
        {
            "sale": "string"
        }
    ],
    "items": [
        {
            "item": "string",
            "variation": "string",
            "qty": 0
        }
    ],
    "details": "string",
    "dateForeseenIni": "string",
    "dateForeseenFinal": "string",
    "tags": [
        {
            "tagId": "string"
        }
    ],
    "customFields": [
        {
            "fieldId": "string",
            "value": "string"
        }
    ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Success

application/json

Body

succes

boolean

requerido

message

string

requerido

OP registrada com sucesso

response

object (po)

requerido

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.

Exemplo

{
    "succes": true,
    "message": "string",
    "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"
            }
        ]
    }
}