Uptime serviços Zydon

Coupons

Obter Cupom

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
get
GET /api/sales/coupons/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "is_active": true,
  "type": "ORDER_VALUE",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "value": 1,
  "partner_use_limit": 1,
  "coupon_use_limit": 1,
  "start_date": "2025-07-01T00:15:55.428Z",
  "end_date": "2025-07-01T00:15:55.428Z",
  "minimum_items_quantity": 1,
  "minimum_items_value": 1,
  "only_available_for_mobile_app": true,
  "maximum_discount_value": 1,
  "only_available_for_first_sale": true,
  "allowed_with_free_shipping_discount": true,
  "allowed_with_product_discount": true,
  "allowed_with_order_value_discount": true,
  "maximum_cumulative_discount_value": 1,
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text"
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text",
      "name": "text"
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ]
}

Atualizar Cupom

put
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
is_activebooleanObrigatório
typestring · enumObrigatórioValores possíveis:
namestringObrigatório
codestringOpcional
value_typestring · enumObrigatórioValores possíveis:
valuenumberObrigatório
partner_use_limitinteger · int32Opcional
coupon_use_limitinteger · int32Opcional
start_datestring · dateOpcional
end_datestring · dateOpcional
minimum_items_quantitynumberObrigatório
minimum_items_valuenumberObrigatório
only_available_for_mobile_appbooleanObrigatório
maximum_discount_valuenumberOpcional
only_available_for_first_salebooleanObrigatório
allowed_with_free_shipping_discountbooleanObrigatório
allowed_with_product_discountbooleanObrigatório
allowed_with_order_value_discountbooleanObrigatório
maximum_cumulative_discount_valuenumberOpcional
is_partner_specificbooleanObrigatório
is_company_specificbooleanObrigatório
is_payment_method_specificbooleanObrigatório
Respostas
201
Coupon updated successfully
application/json
put
PUT /api/sales/coupons/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 749

{
  "is_active": true,
  "type": "ORDER_VALUE",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "value": 1,
  "partner_use_limit": 1,
  "coupon_use_limit": 1,
  "start_date": "2025-07-01",
  "end_date": "2025-07-01",
  "minimum_items_quantity": 1,
  "minimum_items_value": 1,
  "only_available_for_mobile_app": true,
  "maximum_discount_value": 1,
  "only_available_for_first_sale": true,
  "allowed_with_free_shipping_discount": true,
  "allowed_with_product_discount": true,
  "allowed_with_order_value_discount": true,
  "maximum_cumulative_discount_value": 1,
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text"
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text"
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ]
}
{
  "id": "text"
}

Remover Cupom

delete
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
Cupom removed successfully
application/json
Respostaobject
delete
DELETE /api/sales/coupons/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{}

Listar Cupons

get
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
Respostas
200
OK
application/json
get
GET /api/sales/coupons HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "coupon_use_limit": 1,
  "coupon_used_quantity": 1,
  "status": "INACTIVE",
  "start_date": "2025-07-01T00:15:55.428Z",
  "end_date": "2025-07-01T00:15:55.428Z"
}

Criar Cupom

post
Autorizações
Corpo
idstringOpcional
is_activebooleanObrigatório
typestring · enumObrigatórioValores possíveis:
namestringObrigatório
codestringOpcional
value_typestring · enumObrigatórioValores possíveis:
valuenumberObrigatório
partner_use_limitinteger · int32Opcional
coupon_use_limitinteger · int32Opcional
start_datestring · dateOpcional
end_datestring · dateOpcional
minimum_items_quantitynumberObrigatório
minimum_items_valuenumberObrigatório
only_available_for_mobile_appbooleanObrigatório
maximum_discount_valuenumberOpcional
only_available_for_first_salebooleanObrigatório
allowed_with_free_shipping_discountbooleanObrigatório
allowed_with_product_discountbooleanObrigatório
allowed_with_order_value_discountbooleanObrigatório
maximum_cumulative_discount_valuenumberOpcional
is_partner_specificbooleanObrigatório
is_company_specificbooleanObrigatório
is_payment_method_specificbooleanObrigatório
Respostas
201
Coupon created successfully
application/json
post
POST /api/sales/coupons HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 761

{
  "id": "text",
  "is_active": true,
  "type": "ORDER_VALUE",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "value": 1,
  "partner_use_limit": 1,
  "coupon_use_limit": 1,
  "start_date": "2025-07-01",
  "end_date": "2025-07-01",
  "minimum_items_quantity": 1,
  "minimum_items_value": 1,
  "only_available_for_mobile_app": true,
  "maximum_discount_value": 1,
  "only_available_for_first_sale": true,
  "allowed_with_free_shipping_discount": true,
  "allowed_with_product_discount": true,
  "allowed_with_order_value_discount": true,
  "maximum_cumulative_discount_value": 1,
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text"
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text"
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ]
}
{
  "id": "text"
}