createOrder

Criando um pedido no armazenamento de pedidos 🔐 Este método requer autorização.

Orders.createOrder(marker, body, langCode)

 const body = {
    "formIdentifier": "orderForm",
    "paymentAccountIdentifier": "cash",
    "formData": {
        "marker": "order_name",
        "value": "Ivan",
        "type": "string"
    },
    "products": [
        {
            "productId": 2,
            "quantity": 2
        }
    ]
}

const value = await Orders.createOrder('my-order', body)

Esquema

marker:* string
Identificador textual do objeto de armazenamento de pedidos
exemplo: my-order

body:* IOrderData
Objeto para criar um pedido
exemplo:

langCode: String
Campo de idioma opcional
exemplo: en_US

Esquema (body)

formIdentifier: string
identificador textual do objeto de formulário vinculado ao armazenamento de pedidos
exemplo: bars

paymentAccountIdentifier: string
identificador textual do objeto de pagamento vinculado ao armazenamento de pedidos
exemplo: payment1

statusIdentifier: string
identificador textual do objeto de status do pedido (se não especificado, o status padrão será atribuído)
exemplo: inprogress

formData: FormDataType
dados enviados pelo formulário vinculado ao armazenamento de pedidos
exemplo:

[
  {
    "marker": "name_1",
    "value": "Name"
  }
]

products Record<string, string | any>[]
array de produtos adicionados ao pedido

productId: number
identificador do produto
exemplo: 12

quantity: number
quantidade do produto
exemplo: 1

Este método recupera um objeto de armazenamento de pedidos por marcador. O método adicionará o idioma padrão ao corpo da solicitação. Se você quiser mudar o idioma, basta passá-lo como o segundo argumento.

Exemplo de retorno:

{
  "formIdentifier": "bars",
  "paymentAccountIdentifier": "payment1",
  "statusIdentifier": "inprogress",
  "formData": [
      {
        "marker": "marker_1",
        "type": "string",
        "value": "Name"
      }
  ],
  "products": [
    {
      "productId": 1,
      "quantity": 2
    },
    {
      "productId": 2,
      "quantity": 3
    }
  ],
  "createdDate": "2024-06-21T09:42:54.848Z",
  "currency": "USD",
  "totalSum": 345
}

Esquema

statusIdentifier: string
identificador textual do status do pedido
exemplo: inprogress

formIdentifier: string
identificador textual do status do formulário
exemplo: order-form

paymentAccountIdentifier string
identificador textual do pagamento do pedido
exemplo: payment-1

formData FormDataType
dados enviados pelo formulário vinculado ao armazenamento de pedidos
exemplo:

[
  {
    "marker": "name_1",
    "value": "Name"
  }
]

products Record<string, string | any>[]
array de produtos adicionados ao pedido

totalSum string
valor total do pedido
exemplo: 12.00

currency string
moeda utilizada para pagar o pedido
exemplo: USD

createdDate string
data em que o pedido foi criado
exemplo: 2023-01-01 12:12