API de Integração - Registro de Término de Separação

Término de Separação

Permite registrar ou cancelar o término da separação de um pedido.

Propriedades

Término de Separação

Nome	Descrição	Tipo	Tamanho	Obrigatório	Obs
data	Data/Hora do término da separação	date	-	S	No formato ISO 8601 'YYYY-MM-DD"T"HH:MI:SS TZH:TZM'
itens	Itens separados	array(Item)	-	S	Se não fornecido, liberará o saldo de todos os itens
transportador	Transportador	Transportador	-	N	Se provido o código, os demais campos podem ser nulos;
volumes	Volumes	array(Volume)	-	N	Se não fornecido, usará o algoritmo padrao de calculo de volumes e considerará as qtdes liberadas dos itens para o cálculo.

Item

Nome	Descrição	Tipo	Tamanho	Obrigatório	Obs
cod_produto	Código do Produto	string	25	S
qtd_liberada	Quantidade Liberada	number	20,10	S

Transportador

Nome	Descrição	Tipo	Tamanho	Obrigatório	Obs
codigo	Código do Transportador	number	6	N
cpf_cnpj	CPF ou CNPJ do Transportador	string	18	N
nome	Nome do Transportador	string	100	N
endereco	Endereço do Transportador	string	50	N
nome_cidade	Nome da Cidade do Transportador	string	50	N
uf	UF do Transportador	string	2	N
fone	Fone do Transportador	string	15	N
placas_veiculo	Placas do Veículo	array(PlacaVeiculo)	-	N	Suporta até quatro placas

PlacaVeiculo

Nome	Descrição	Tipo	Tamanho	Obrigatório	Obs
numero_placa	Número da Placa	string	7	N
uf_placa	UF da Placa	string	2	N

Volume

Nome	Descrição	Tipo	Tamanho	Obrigatório	Obs
peso_bruto	Peso Bruto	number	20,10	S
peso_liquido	Peso Líquido	number	20,10	S
marca	Marca	string	15	N
especie	Espécie	string	15	N
volume_cubico	Volume Cúbico	number	20,10	N

Endpoints

PUT /api/termino-separacao-pedido/{id}

Registra o término de separação de um pedido existente.

Parâmetros

Nome	Descrição	Tipo
id_pedido	Id do Pedido	number

Exemplo

curl --request PUT \
--location ${URL_BASE}/api/termino-separacao-pedido/{id} \
--header 'Content-Type: application/json' \
--header 'Authorization: ${TOKEN}' \
--data '{
    "data": "31/01/2024 11:30:45",
    "itens": [
        {
            "cod_produto": "002624",
            "qtd_liberada": 15
        }
    ],
    "transportador": {
        "codigo": null,
        "cpf_cnpj": null,
        "nome": "nome transp",
        "endereco": "end transp",
        "nome_cidade": "cid transp",
        "uf": "RS",
        "fone": "54 99999999",
        "placas_veiculo": [
            {
                "numero_placa": "AAAB9X99",
                "uf_placa": "RS"
            },
            {
                "numero_placa": "AAAB9Y99",
                "uf_placa": "RS"
            }
        ]
    },
    "volumes": {
        "peso_bruto": 999,
        "peso_liq": 99,
        "marca": "marca",
        "especie": "especie",
        "volume_cubico": 9
    }
}'

HTTP/1.1 200 OK

DELETE /api/termino-separacao-pedido/{id}

Exclui o registro do término de separação de um pedido existente.

Exemplo

curl --request DELETE --location ${URL_BASE}/api/termino-separacao-pedido/{id} \
--header 'Content-Type: application/json' \
--header 'Authorization: ${TOKEN}' \

HTTP/1.1 200 OK