Criar um pedido

Cria um pedido enviando um payload JSON.

Formato dos erros

Erros de validação são serializados pelo filtro global da CrediPay em duas formas:

  • CredixErrorResponse (uma única validação): { message, code, context, timestamp, path, request_id }
  • CredixAggregateErrorResponse (várias validações falhando juntas): { message, code: "ORDER_VALIDATION_AGGREGATE_ERROR", errors: [{ message, code, context }], timestamp, path, request_id }

O campo code é estável e deve ser usado pelo seu sistema como chave de identificação do erro. A mensagem em message permanece em inglês para evitar quebras quando a tradução evoluir.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Dados do pedido.

string
required

CNPJ do comprador.

string
required

CNPJ do vendedor.

metadata
object
required

Qualquer metadado que você queira anexar ao pedido. Tamanho serializado máximo: 102400 caracteres.

string
Defaults to REF-10230456

ID interno do pedido do vendedor.

installments
array of objects
required

Parcelas

installments*
items
array of objects
required

Itens do pedido.

items*
contactInformation
object
required

Informações de Contato do comprador.

shippingLocation
object
required

Endereço de Entrega.

string
enum
required
Defaults to DDF

O modo de processamento da nota fiscal. 'DDF' significa que o vendedor faz o upload da nota fiscal para a plataforma antes da entrega das mercadorias. 'DDE' significa que o vendedor faz o upload da nota fiscal para a plataforma após a entrega das mercadorias.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json