Operações de CRUD

No Recurso Raiz, podemos acessar as principais operações do serviço (CRUD), através dos métodos do padrão HTTP, conforme tabela abaixo:

CRUD Métodos HTTP
Create POST
Read GET
Update PUT
Delete DELETE

Ou seja, no serviço /orders do exemplo acima, se fizermos uma operação GET, obteremos como resposta uma lista de pedidos, e se fizermos um POST, iremos salvar um novo pedido (disponível apenas em ambiente de Sandbox).

A tabela abaixo mostra todas as operações que conseguimos executar sobre o serviço /orders:

Recurso GET POST PUT DELETE
/orders Lista os pedidos Cria novo pedido ou vários (quando permitir batch) * *
/orders/564 Detalhes do pedido 564 *** ** Atualiza o pedido 564 Exclui o pedido 564
/orders/564/orderItems Lista de itens do pedido 564 Cria novo item no pedido 564 * *
/orders/564/orderItems/1 Detalhes do item 1 do pedido 564 ** Atualiza o item 1 do pedido 564 Exclui o item 1 do pedido 564
* O método não deve ser implementado em coleções, então espera-se o retorno com
ERRO 405 - method not allowed ** O método não deve ser implementado em itens, então espera-se o retorno com
ERRO 405 - method not allowed. No entanto, é usado no caso de uma chamada assíncrona. *** Como o pedido é um recurso agregador, deverá retornar por default todos os itens associados
Português, Brasil