DOCS

Update orders

/

Criar pedidos

Saiba como atualizar itens em um pedido.

GraphQL

EM BREVE

Se você criou um pedido, mas percebe que nem todos os itens podem ser atendidos devido a remessas incompletas ou outras circunstâncias imprevistas, você pode usar a mutação orderItemUpdate para remover itens do pedido. Uma vez que um item é removido, realizaremos um novo cálculo de custo total e atualizaremos a fatura deste pedido para refletir o novo valor que será cobrado. Se você já foi cobrado, adicionaremos esse valor como crédito em sua próxima fatura.

Prepare a entrada da mutação 

A mutação orderCreate requer dados de entrada específicos. Embora campos adicionais estejam disponíveis, os seguintes campos são obrigatórios:

  • productId ou sku: O ID do produto ou SKU que você usa para identificar os itens no pedido (O valor que você usa para identificar produtos em seu sistema).
  • accountOrderNumber: O número do pedido que você atribuiu ao pedido (geralmente o número do pedido da plataforma).

Você só pode remover itens de um pedido se eles ainda não tiverem sido enviados.

Envie a mutação 

Depois de ter os dados de entrada necessários, envie a mutação GraphQL para o endpoint da API usando sua biblioteca de cliente ou ferramenta escolhida. Aqui está um exemplo de como você pode estruturar a mutação:

Mutação

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
mutation {
  orderItemUpdate(
    orderId: "order_4f52ec0e-3467-11ed-b878-0242ac120002"
    accountOrderNumber: "AO-67890"
    itemId: "item_8659ec0e-3467-11ed-b878-0242ac120002"
    itemSku: "T123-BLUE"
    quantity: 1
  ) {
    order {
      accountOrderNumber
      createdAt
      createdBy
      currencyCode
      id
      items {
        id
        name
        quantity
        amount
        currencyCode
      }
      status
      updatedAt
      updatedBy
    }
  }
}

Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "data": {
    "orderItemUpdate": {
      "order": {
        "accountOrderNumber": "AO-67890",
        "createdAt": "2024-06-01T12:00:00Z",
        "createdBy": "user_3258ec0e-3467-11ed-b878-0242ac120002",
        "currencyCode": "USD",
        "id": "order_4f52ec0e-3467-11ed-b878-0242ac120002",
        "items": [
          {
            "id": "item_8659ec0e-3467-11ed-b878-0242ac120002",
            "name": "T-Shirt",
            "quantity": 0,
            "amount": 19.99,
            "currencyCode": "USD"
          }
        ],
        "status": "OPEN",
        "updatedAt": "2024-07-09T12:20:00Z",
        "updatedBy": "user_4258ec0e-3467-11ed-b878-0242ac120002"
      }
    }
  }
}

Esta página foi útil?