Coupons

Obter Cupom

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

404

Coupon was not found

application/json

500

An internal server error was thrown

application/json

get

/coupons/{id}

HTTPcURLJavaScriptPython

GET /api/sales/coupons/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-15T08:29:06.220Z",
  "end_date": "2025-12-15T08:29:06.220Z",
  "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

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

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

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

/coupons/{id}

HTTPcURLJavaScriptPython

PUT /api/sales/coupons/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-15",
  "end_date": "2025-12-15",
  "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

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

Cupom removed successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete

/coupons/{id}

HTTPcURLJavaScriptPython

DELETE /api/sales/coupons/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Listar Cupons

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

404

Coupon was not found

application/json

500

An internal server error was thrown

application/json

get

/coupons

HTTPcURLJavaScriptPython

GET /api/sales/coupons HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "coupon_use_limit": 1,
  "coupon_used_quantity": 1,
  "status": "INACTIVE",
  "start_date": "2025-12-15T08:29:06.220Z",
  "end_date": "2025-12-15T08:29:06.220Z"
}

Criar Cupom

post

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

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

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/coupons

HTTPcURLJavaScriptPython

POST /api/sales/coupons HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-15",
  "end_date": "2025-12-15",
  "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"
}