Cards

Listar Cards do Widget

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

newOrderIdstringObrigatório

ID do new order

widgetIdstringObrigatório

ID do widget

Parâmetros de consulta

sortstringOpcionalDefault: order

dirstringOpcionalDefault: asc

Respostas

200

Widget Cards listed

application/json

idstringOpcional

titlestringOpcional

subtitlestringOpcional

iconstring · enumOpcionalValores possíveis:

redirect_linkstringOpcional

orderinteger · int32Opcional

404

New order was not found

application/json

422

A query param was invalid

application/json

500

An internal server error was thrown

application/json

get/new-orders/{newOrderId}/widgets/{widgetId}/cards

GET /api/b2b/new-orders/{newOrderId}/widgets/{widgetId}/cards HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "title": "text",
    "subtitle": "text",
    "icon": "CHECKLIST",
    "redirect_link": "text",
    "order": 1
  }
]

Criar, Atualizar e Excluir Cards do Widget

put

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

newOrderIdstringObrigatório

ID do novo pedido

widgetIdstringObrigatório

ID do widget

Corpoobject · UpdateNewOrderWidgetCardRequest[]

idstringOpcional

titlestringOpcional

subtitlestringOpcional

iconstring · enumOpcionalValores possíveis:

redirect_linkstringOpcional

orderinteger · int32Opcional

Respostas

200

application/json

idstringOpcional

titlestringOpcional

typestring · enumOpcionalValores possíveis:

activebooleanOpcional

banner_idstringOpcional

orderinteger · int32Opcional

product_order_typestring · enumOpcionalValores possíveis:

product_typestring · enumOpcionalValores possíveis:

listing_rule_idstringOpcional

404

Widget was not found

application/json

500

An internal server error was thrown

application/json

put/new-orders/{newOrderId}/widgets/{widgetId}/cards

PUT /api/b2b/new-orders/{newOrderId}/widgets/{widgetId}/cards HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

[
  {
    "id": "text",
    "title": "text",
    "subtitle": "text",
    "icon": "CHECKLIST",
    "redirect_link": "text",
    "order": 1
  }
]

{
  "id": "text",
  "title": "text",
  "type": "BANNER",
  "active": true,
  "banner_id": "text",
  "order": 1,
  "product_order_type": "BEST_SELLERS",
  "product_type": "SUGGESTED_PRODUCT",
  "listing_rule_id": "text"
}