Swagger:

Para acessar o swagger, insira após o domínio da loja '/web-api/docs/index.html'

Exemplo:

• https://www.nomedaloja.com.br/web-api/docs/index.html

Collection Postman:

OCA.postman_collection(OCA).json

Contratos de Checkout (Request)

• Base path ilustrativo: /web-api/v1/Shopping/Checkout
• Autenticação: Authorization: Basic <credenciais>
• Content-Type: application/json

1) Recuperar Checkout

• Endpoint: POST /Get
  • Objetivo: Retornar o estado atual do Checkout (endereços, grupos/pagamentos, etc.)

Body (request)

Exemplo mínimo

 {
   "sessionID":"<SessionID>",
   "BasketID":123456,
   "BasketAuthorityToken":"<BasketAuthorityToken>"
}

2) Definir Opção de Entrega

• Endpoint: POST /SetDeliveryOption
  • Objetivo: Selecionar a opção de entrega para um grupo do carrinho/checkout.

Body (request)

Exemplo mínimo

{
   "sessionID":"<SessionID>",
   "deliveryOptionID":"3_589-fe_entrega-oms-STANDARD",
   "groupKey":"14_group1",
   "BasketID":123456,
   "BasketAuthorityToken":"<BasketAuthorityToken>"
}

3) Definir Endereço (seleção de endereço salvo)

• Endpoint: POST /SetAddress
  • Objetivo: Definir um endereço previamente cadastrado como entrega e/ou cobrança.

Body (request)

Exemplo mínimo

{
   "ID":338862,
   "SessionID":"<SessionID>",
   "BasketID":123456,
   "BasketAuthorityToken":"<BasketAuthorityToken>",
   "SetAsShippingAddress":true,
   "SetAsBillingAddress":true
}

4) Finalizar Pedido (PlaceOrder)

• Endpoint: POST /PlaceOrder
  • Objetivo: Efetivar o pedido com uma ou mais formas de pagamento.

Body (request)

Estrutura de Payments[]

Estrutura de CardInfo

Exemplo mínimo

{
   "Payments":[
      {
         "PaymentMethodID":955,
         "CardInfo":{
            "Holder":"NOME DO CLIENTE",
            "Number":"4000 0000 0000 0010",
            "SecurityCode":"123",
            "Month":1,
            "Year":2026,
            "ExpirationDate":"01/26"
         },
         "Installments":1
      }
   ],
   "SessionID":"<SessionID>"
}