v1

latestOpenAPI 3.1.02026-07-26223346.1 KB
Produtos

get/products/{id}

Path parameters

idstring required

Response

Response description

idstring
namestring
typestring
created_atstring
currencystring
pricenumber
affiliate_enabledboolean
statusstring
payment_typestring

Example response

{
  "id": "7b5dc633-6b10-4b98-90c7-ea20a7610bd0",
  "name": "Meu Produto",
  "type": "membership",
  "created_at": "2023-08-09T09:42:59.074Z",
  "currency": "BRL",
  "price": 1000,
  "affiliate_enabled": true,
  "status": "active",
  "payment_type": "charge",
  "links": [
    {
      "id": "49c6cd08-11d7-47a1-970c-37c2c03ea9ec",
      "custom_name": "Meu Link",
      "product_id": "451f39f4-cced-42e9-8597-c7fe6179537a",
      "currency": "BRL",
      "price": 1000,
      "status": "active"
    }
  ],
  "bumps": [
    {
      "type": "object",
      "properties": {
        "id": "b300434a-9993-4f4b-a481-f16299c5729c",
        "action_call": "Sim, eu aceito essa oferta especial!",
        "oto_description": "Adicione a compra",
        "oto_headline": "Nome do seu produto",
        "color": "#f7f7f7",
        "link": {
          "id": "49c6cd08-11d7-47a1-970c-37c2c03ea9ec",
          "custom_name": "Meu Link",
          "product_id": "451f39f4-cced-42e9-8597-c7fe6179537a",
          "currency": "BRL",
          "price": 1000,
          "status": "active"
        }
      }
    }
  ],
  "offers": [
    {
      "id": "451f39f4-cced-42e9-8597-c7fe6179537a",
      "name": "Nome do seu produto",
      "currency": "BRL",
      "price": 1000,
      "active": true
    }
  ],
  "event_settings": {
    "address": {
      "route": "My route",
      "administrative_area_level_2": "My City",
      "administrative_area_level_1": "My State",
      "country": "My country",
      "postal_code": "32121-123",
      "latitude": -19.2312,
      "longitude": -24.2312
    },
    "enable_handtags": true,
    "handtag_code_type": "qr_code",
    "handtag_auto_print": true,
    "description_enabled": true,
    "collect_phone": true,
    "start_date": "2023-10-31T16:53:05.119Z",
    "end_date": "2023-10-31T16:53:05.119Z",
    "sale_start_at": "2023-10-31T16:53:05.119Z",
    "sale_end_at": "2023-10-31T16:53:05.119Z"
  },
  "event_batches": [
    {
      "id": "82265302-93f5-4dd8-b6dd-3b8f2c4bc07d",
      "name": "Primeiro Lote",
      "max_tickets": 500,
      "available_tickets": 500,
      "currency": "BRL",
      "price": 45000,
      "created_at": "2023-10-31T16:53:05.119Z",
      "updated_at": "2023-10-31T16:53:05.119Z"
    }
  ],
  "subscriptions": [
    {
      "id": "95c8321b-2bf9-432f-aad5-7b3e8c3f2229",
      "name": "basic",
      "description": "my description",
      "currency": "BRL",
      "price": 5000,
      "frequency": "monthly",
      "installments": 1,
      "setup_fee": 500,
      "setup_fee_enabled": true
    }
  ],
  "revenue_partners": [
    {
      "account_id": "RpL2LaVt13ENs0Q",
      "legal_name": "My Revenue Partner",
      "status": "active",
      "document_id": "12345678910",
      "percentage": 50,
      "start_date": "2023-10-31T16:53:05.119Z",
      "end_date": "2023-10-31T16:53:05.119Z"
    }
  ]
}