Criar Pedido

Criar um novo pedido

POST https://api.gestao.plus/order-external

Nesta rota você pode adicionar um contato ao usuário.

Headers

Name
Type
Description

x-api-key*

string

Token de acesso ERP

Origin*

string

URL de origem

Request Body

Name
Type
Description

code

string

Código de identificação da venda

date

string

Data da venda: Y-m-d H:i:s

utmCampaign

string

UTM Campaign

utmId

string

UTM ID

utmMedium

string

UTM Medium

utmSource

string

UTM Source

user*

object

Objeto com os dados do cliente

orderItems*

array

Array de itens

{
    "code": "SUCCESS_ORDER_CREATED",
    "data": {
        "publicToken": "OMzMyMQ_MTY4OTYyMjM4MDUEaa1xNjE_7C44FWNkaVR-GJB871Mb2g",
        "orderCode": "CÓDIGO_DA_VENDA",
        "orderId": "ID_DA_VENDA"
    },
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Unknown",
    "status": 201,
    "detail": "Order successfully created"
}

Exemplo de corpo da requisição:

Detalhando "user":

{
    "user": { // Dados do cliente
        "name": "required", // Nome
        "nameLaw": "", // Razão Social
        "email": "required", // E-mail
        "document": "required", // Documento
        "cellphone": "", // Celular
        "phone": "", // Telefone
        "stateRegistration": "", // Inscrição estadual
        "zipCode": "", // CEP
        "address": "", // Endereço
        "number": "", // Número
        "neighborhood": "", // Bairro
        "addressDetail": "", // Complemento
        "city": "", // Cidade
        "state": "" // Estado
    }

Detalhando "orderItems":

{
    "orderItems": [
        {
            "product": "required", // SKU do produto
            "quantity": "required", // Quantidade
            "price": "", // Valor desse item
            "discount": "" // Desconto nesse item (R$)
        }
    ]

Exemplo completo do corpo da requisição

{
    "code": "",
    "date": "",
    "note": "",
    "user": {
        "name": "",
        "nameLaw": "",
        "email": "",
        "document": "",
        "cellphone": "",
        "phone": "",
        "stateRegistration": "",
        "zipCode": "",
        "address": "",
        "number": "",
        "neighborhood": "",
        "addressDetail": "",
        "city": "",
        "state": ""
    },
    "orderItems": [
        {
            "product": "",
            "quantity": "",
            "price": "",
            "discount": ""
        }
    ]
}

Last updated

Was this helpful?