createOrder

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

Descrição

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. Ele cria um pedido no armazenamento de pedidos especificado. Retorna uma Promise que resolve para um objeto IBaseOrdersEntity.

Orders.createOrder(

marker*, body*, body.formIdentifier*, body.paymentAccountIdentifier*, body.formData*, formData.marker*, formData.type*, formData.value*, body.products*, langCode

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Identificador textual do objeto de armazenamento de pedidos
exemplo: "order_storage_1"

body(obrigatório): IOrderData
Objeto para criar um pedido
exemplo:

{
  "formIdentifier": "bar-orders-form",
  "paymentAccountIdentifier": "usd-payment",
  "formData": {
    "marker": "name_1",
    "value": "Nome",
    "type": "string"
  },
  "products": [
    {
      "productId": 1,
      "quantity": 2
    }
  ]
}

body.formIdentifier(obrigatório): string
Identificador textual do objeto de formulário vinculado ao repositório de pedidos.
exemplo: "bar-orders-form"

body.paymentAccountIdentifier(obrigatório): string
Identificador textual do objeto de pagamento vinculado ao repositório de pedidos.
exemplo: "payment-1"

body.formData(obrigatório): IOrdersFormData | IOrdersFormData[]
Dados do formulário vinculados ao repositório de pedidos.
exemplo:

[
  {
    "marker": "name_1",
    "value": "Nome",
    "type": "string"
  }
]

formData.marker(obrigatório): string
Marcador do campo do formulário.
exemplo: "name_1"

formData.type(obrigatório): string
Tipo de valor.
exemplo: "string"

formData.value(obrigatório): string
Valor.
exemplo: "Nome"

body.products(obrigatório): IOrderProductData[]
Um array de produtos pedidos.
exemplo: []

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo mínimo

const body = {
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": {
    {
      "marker": "order_name",
      "type": "string",
      "value": "Ivan"
    }
  },
  "products": [
    {
      "productId": 2,
      "quantity": 2
    }
  ]
};
const response = await Orders.createOrder("my-order", body);

Exemplo de resposta

{
  "id": 328,
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": [
    {
      "marker": "order_name",
      "value": "Ivan",
      "type": "string"
    }
  ],
  "products": [
    {
      "productId": 2957,
      "quantity": 2
    }
  ],
  "currency": "",
  "totalSum": 300,
  "createdDate": "2025-11-06T09:28:05.249Z"
}

Esquema de resposta

Esquema: IBaseOrdersEntity

id: number
Identificador do objeto.
exemplo: 1

formIdentifier: string
Identificador textual do formulário.
exemplo: "bar-orders-form"

paymentAccountIdentifier: string
Identificador textual do pagamento do pedido.
exemplo: "payment-1"

formData: IOrdersFormData[]
Dados submetidos pelo formulário vinculado ao armazenamento de pedidos.
exemplo:

[
  {
    "marker": "name_1",
    "value": "Nome",
    "type": "string"
  }
]

products: IOrderProductsData[]
Array de produtos adicionados ao pedido.
exemplo:

[
  {
    "id": 2957,
    "title": "Cosmo",
    "sku": null,
    "previewImage": null,
    "price": 150,
    "quantity": 2
  }
]

currency: string
Moeda utilizada para pagar o pedido.
exemplo: "USD"

totalSum: number
Valor total do pedido.
exemplo: NaN

createdDate: string
Data de criação do pedido.
exemplo: "2023-10-01T12:00:00Z"

statusIdentifier: string
Identificador textual do objeto de status do pedido (se não definido, o status padrão será atribuído).
exemplo: "status-1"

---