### GET /store Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index Retrieve basic registration data for the specified wBuy virtual store. ```APIDOC ## GET /store ### Description Use this endpoint to retrieve some registration data of the virtual store in question on wBuy. ### Method GET ### Endpoint `https://sistema.sistemawbuy.com.br/api/v1/store/` ### Parameters #### Headers - **Authorization** (string) - Required - The authentication token for API access. ### Request Example ```json { "example": "curl --location 'https://sistema.sistemawbuy.com.br/api/v1/store/' \ --header 'Authorization: {{AUTHORIZATION}}'" } ``` ### Response #### Success Response (200) This request does not return a response body. #### Response Example No response body ``` -------------------------------- ### GET /payment-gateways Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index Retrieves a list of payment gateway integrations. Each gateway has an ID and a name. ```APIDOC ## GET /payment-gateways ### Description Retrieves a list of all supported payment gateway integrations. This list is used to identify how payments are processed, such as 'PagSeguro', 'MercadoPago', and 'Cielo'. The ID is returned with each order in the `pagamento => id` array. ### Method GET ### Endpoint `/payment-gateways` ### Parameters None ### Request Example None ### Response #### Success Response (200) - **payment_gateways** (array) - A list of payment gateway objects. - **id** (integer) - The unique identifier for the payment gateway. - **name** (string) - The name of the payment gateway (e.g., "PagSeguro"). #### Response Example ```json { "payment_gateways": [ { "id": 1, "name": "PagSeguro" }, { "id": 5, "name": "Depósito bancário" }, { "id": 6, "name": "API Cielo eCommerce 3.0 (Transparente)" }, ... ] } ``` ``` -------------------------------- ### GET /payment-methods Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index Retrieves a list of customer-facing payment methods. These are the options presented to the user during checkout. ```APIDOC ## GET /payment-methods ### Description Retrieves a list of customer-facing payment methods available for transactions. These are the actual options displayed to customers during checkout, such as 'Credit Card', 'Pix', and 'Bank Slip'. ### Method GET ### Endpoint `/payment-methods` ### Parameters None ### Request Example None ### Response #### Success Response (200) - **payment_methods** (array) - A list of payment method objects. - **id** (integer) - The unique identifier for the payment method. - **name** (string) - The name of the payment method as presented to the customer (e.g., "Cartão de crédito"). #### Response Example ```json { "payment_methods": [ { "id": 1, "name": "Cartão de crédito" }, { "id": 11, "name": "Cartão de débito" }, { "id": 13, "name": "Pix" }, ... ] } ``` ``` -------------------------------- ### GET /discount-coupon-types Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index Retrieves a list of discount coupon types. These define the nature of a discount, such as 'Free Shipping' or 'Percentage Discount'. ```APIDOC ## GET /discount-coupon-types ### Description Retrieves a list of available discount coupon types. These types define how a discount is applied, such as 'Free Shipping', 'Percentage Discount', or 'Fixed Value Discount'. ### Method GET ### Endpoint `/discount-coupon-types` ### Parameters None ### Request Example None ### Response #### Success Response (200) - **coupon_types** (array) - A list of discount coupon type objects. - **id** (integer) - The unique identifier for the coupon type. - **name** (string) - The name of the coupon type (e.g., "Frete grátis"). #### Response Example ```json { "coupon_types": [ { "id": 1, "name": "Frete grátis" }, { "id": 2, "name": "Porcentagem de desconto" }, { "id": 3, "name": "Desconto com valor fixo" } ] } ``` ``` -------------------------------- ### GET /shipping-types Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index Retrieves a list of available shipping types. Each type has a unique ID and a descriptive name. ```APIDOC ## GET /shipping-types ### Description Retrieves a list of all available shipping types used within the system. This list includes options like 'Free Shipping', 'Direct Delivery', 'Correios', and various courier services. ### Method GET ### Endpoint `/shipping-types` ### Parameters None ### Request Example None ### Response #### Success Response (200) - **shipping_types** (array) - A list of shipping type objects. - **id** (integer) - The unique identifier for the shipping type. - **name** (string) - The name of the shipping type (e.g., "Frete Grátis"). #### Response Example ```json { "shipping_types": [ { "id": 1, "name": "Frete Grátis" }, { "id": 2, "name": "Entrega Direta" }, { "id": 3, "name": "Correios" }, ... ] } ``` ``` -------------------------------- ### Retrieve Store Data using cURL Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index This cURL command demonstrates how to make a GET request to retrieve store data from the wBuy API. It includes the necessary Authorization header. ```bash curl --location 'https://sistema.sistemawbuy.com.br/api/v1/store/' \ --header 'Authorization: {{AUTHORIZATION}}' ``` -------------------------------- ### GET /payment-types Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index Retrieves a list of internal payment types. These are system-defined categories for payments. ```APIDOC ## GET /payment-types ### Description Retrieves a list of internal payment types used within the system. These represent the system's classification of payment methods, such as 'credit_card', 'pix', and 'bank_billet'. This data is returned with each order in the `pagamento => tipo_interno` array. ### Method GET ### Endpoint `/payment-types` ### Parameters None ### Request Example None ### Response #### Success Response (200) - **payment_types** (array) - A list of internal payment type objects. - **id** (string) - The internal identifier for the payment type (e.g., "credit_card"). - **name** (string) - The descriptive name of the payment type (e.g., "Cartão de crédito"). #### Response Example ```json { "payment_types": [ { "id": "credit_card", "name": "Cartão de crédito" }, { "id": "debit_card", "name": "Cartão de débito" }, { "id": "transfer", "name": "Depósito bancário" }, ... ] } ``` ``` -------------------------------- ### Set User-Agent Header for API Requests Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index It is required to include a User-Agent header in all API requests. This header should specify the name of your application and a support email address. ```text User-Agent: MEUERP (email@meuemail.com) ``` -------------------------------- ### Fixed Data Tables Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index Information on fixed data tables used within the wBuy system, including product attributes and order statuses. ```APIDOC ## Fixed Data Tables ### Product Attributes #### Audience Gender | Key (to use) | Value | |---|---| | female | Feminino | | male | Masculino | | unisex | Unissex | #### Fit | Key (to use) | Value | |---|---| | regular | Tamanho normal | | petite | Tamanho pequeno | | plus | Plus Size | | big and tall | Plus Size+ | | maternity | Gestante | #### Age Group | Key (to use) | Value | |---|---| | newborn | Recém-nascido | | infant | 3 a 12 meses | | toddler | 1 a 5 anos | | kids | Infantil | | adult | Adulto | ### Order Status | ID | Name | |---|---| | 1 | Aguardando pagamento | | 2 | Pagamento em análise | | 3 | Pagamento efetuado | | 13 | Em produção | | 4 | Em expedição | | 5 | Em transporte | | 15 | Saiu para entrega | | 16 | Disponível para retirada | | 6 | Pedido cancelado | | 7 | Pedido concluído | | 8 | Pagamento negado | | 9 | Disponível | | 10 | Devolvido | | 11 | Pedido em análise | | 12 | Fatura gerada | | 14 | Nota fiscal emitida | ``` -------------------------------- ### Authenticate API Requests with Base64 Hash Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index To authenticate API requests, generate a base64 hash using your API user and password. This hash is then sent in the 'Authorization' header as a Bearer token. Alternatively, the 'x-token' header can be used. ```text Authorization: Bearer BASE64(usuario_api:senha_api) Example: Authorization: Bearer dXN1YXJpb19hcGk6c2VuaGFfYXBp ``` -------------------------------- ### General API Information Source: https://documenter.getpostman.com/view/4141833/RWTsquyN/index Information about the wBuy API, including the base endpoint, authentication, and rate limits. ```APIDOC ## wBuy API Documentation This documentation aims to assist with API integration and facilitate the usability of the wBuy Virtual Stores platform. ### Base Endpoint The connection endpoint for the wBuy REST JSON API is: `https://sistema.sistemawbuy.com.br/api/v1` ### Test Environment Currently, there is no dedicated sandbox environment. However, registered wBuy partners can create a test account with full platform access. Sign up at https://www.wbuy.com.br/afiliados/ ### Rate Limit 100 requests per credential are allowed within a 60-second interval for any endpoint. Exceeding this limit will result in a `429 Too Many Requests` HTTP status code. ### Available Resources The following resources can be manipulated using GET, POST, PUT, and DELETE methods: * Customers (customer) * Categories (category) * Products (product) * Orders (order) * Discount Coupons (coupon) * Scripts per page (script) * Newsletter (newsletter) * Webhooks (webhook) * Sellers and Affiliates (partnerstore) * Product Reviews (product/review) ### Data Handling All data sent and received by the API must be in JSON format (`application/json`). ### Authentication To use the available methods, you need REST integration keys from your wBuy Control Panel under **Platform > API and webhooks > Options > REST API Integration**. These keys should be sent encoded in the request header. Generate a Base64 hash using your API `User` and `Password` (not your panel login credentials). Example: `Authorization: Bearer BASE64(api_user:api_password)` The header value will look like: `Authorization: Bearer dXN1YXJpb19hcGk6c2VuaGFfYXBp` Alternatively, you can use the `x-token` header instead of `Authorization`. ### User-Agent All requests must include a `User-Agent` header specifying your application name and support email, e.g.: `User-Agent: MYERP (email@myemail.com)` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.