seller.ggsel.net: Schemas

https://seller.ggsel.net/docs/schemas/
Admin
Unable to determine project information - the documentation page returned a 'Not Found' error.
Tokens:10,038
Snippets:21
Trust Score:9.3
Update:9 months ago
Show doc for...
Tokens:
Raw
### Offer Search Object Schema Example (JSON)

Source: https://seller.ggsel.net/docs/schemas/offer-search-object

An example of the offer_search_object structure in JSON format. This schema defines the expected fields for product search results, including product IDs, names, prices, and sale information.

```json
{
  "retval": 0,
  "retdesc": "string",
  "pages": {
    "name": 0,
    "rows": 0
  },
  "products": [
    {
      "id": 0,
      "name": "string",
      "price": 0,
      "snippets": {
        "info": "string",
        "name": "string"
      },
      "sale_info": {
        "common_base_price": 0,
        "common_price_usd": 0,
        "common_price_eur": 0,
        "common_price_uah": 0
      },
      "sale_percent": 0
    }
  ]
}
```

--------------------------------

### reviews_object JSON Schema Example

Source: https://seller.ggsel.net/docs/schemas/reviews-object

An example of the 'reviews_object' structure in JSON format. This schema defines the fields for returning review data, including metadata like total pages and items, and an array of individual review objects.

```json
{
  "retval": 0,
  "retdesc": "string",
  "totalPages": 0,
  "totalItems": 0,
  "totalGood": 0,
  "totalBad": 0,
  "reviews": [
    {
      "id": 0,
      "info": "string",
      "good": 0,
      "type": "string",
      "date": "string",
      "invoice_id": 0,
      "name": "string",
      "comment": "string",
      "owner_id": 0
    }
  ]
}
```

--------------------------------

### Offer List Object Schema and Example

Source: https://seller.ggsel.net/docs/schemas/offer-list-object

This snippet defines the structure of the offer_list_object, which includes result codes, pagination details, and an array of product rows. Each product row contains information such as product ID, name, price, stock, and sales data. The example demonstrates a typical JSON response for this object.

```JSON
{
  "retval": 0,
  "retdesc": "string",
  "page": 0,
  "count": 0,
  "has_next_page": true,
  "has_previous_page": true,
  "total_count": 0,
  "total_pages": 0,
  "rows": [
    {
      "id_goods": 0,
      "name_goods": "string",
      "info_goods": "string",
      "price": "string",
      "currency": "string",
      "add_info": "string",
      "cnt_sell": 0,
      "cnt_return": 0,
      "cnt_goodresponses": 0,
      "cnt_badresponses": 0,
      "price_usd": 0,
      "price_eur": 0,
      "price_uah": 0,
      "price_rur": 0,
      "in_stock": 0,
      "num_in_stock": 0,
      "visible": 0,
      "commiss_agent": "string",
      "has_discount": true,
      "num_options": 0,
      "sale_info": {
        "common_base_price": 0,
        "common_price_usd": 0,
        "common_price_eur": 0,
        "common_price_rur": 0,
        "sale_end": "string",
        "sale_percent": "string"
      }
    }
  ]
}
```

--------------------------------

### Seller Goods List Object JSON Example

Source: https://seller.ggsel.net/docs/schemas/seller-goods-list-object

An example JSON object representing the seller_goods_list_object. This structure includes top-level fields for result status and seller details, followed by a 'rows' array containing individual product information.

```json
{
  "retval": 0,
  "retdesc": "string",
  "id_seller": 0,
  "name_seller": "string",
  "cnt_goods": 0,
  "pages": 0,
  "page": 0,
  "order_col": "string",
  "order_dir": "string",
  "rows": [
    {
      "id_goods": 0,
      "name_goods": "string",
      "info_goods": "string",
      "price": "string",
      "currency": "string",
      "add_info": "string",
      "cnt_sell": 0,
      "cnt_return": 0,
      "cnt_goodresponses": 0,
      "cnt_badresponses": 0,
      "price_usd": 0,
      "price_eur": 0,
      "price_uah": 0,
      "price_rur": 0,
      "in_stock": 0,
      "num_in_stock": 0,
      "visible": 0,
      "commiss_agent": "string",
      "has_discount": true,
      "num_options": 0,
      "sale_info": {
        "common_base_price": 0,
        "common_price_usd": 0,
        "common_price_eur": 0,
        "common_price_rur": 0,
        "sale_end": "string",
        "sale_percent": "string"
      }
    }
  ]
}
```

--------------------------------

### Offer Search Object

Source: https://seller.ggsel.net/docs/schemas/offer-search-object

This section details the structure of the offer search object, which is returned upon a successful offer search query. It includes result codes, pagination information, and a list of products with their respective details.

```APIDOC
## Offer Search Object

### Description
Represents the structure of the response object for offer search queries. It contains the result status, pagination details, and an array of product objects.

### Method
GET (Assumed, as it's a search object)

### Endpoint
/websites/seller_ggsel_net_schemas/offer_search_object (Assumed based on project path)

### Parameters
#### Query Parameters
(No specific query parameters are detailed in the provided text, but typical search parameters like `query`, `page`, `limit` might be expected).

#### Request Body
(Not applicable for a GET request).

### Response
#### Success Response (200)
- **retval** (integer) - The result code of the operation. 0 typically indicates success.
- **retdesc** (string) - A description of the result.
- **pages** (object) - An object containing pagination information.
  - **name** (integer) - Page number or identifier.
  - **rows** (integer) - Total number of rows or items available.
- **products** (object[]) - An array of product objects.
  - **id** (integer) - The unique identifier for the product.
  - **name** (string) - The name of the product.
  - **price** (number) - The price of the product.
  - **snippets** (object) - Contains additional descriptive snippets for the product.
    - **info** (string) - Informational snippet.
    - **name** (string) - Name snippet.
  - **sale_info** (object) - Information related to sales and discounts.
    - **common_base_price** (number | null) - The common base price of the product.
    - **common_price_usd** (number | null) - The common price in USD.
    - **common_price_eur** (number | null) - The common price in EUR.
    - **common_price_uah** (number | null) - The common price in UAH.
  - **sale_percent** (number | null) - The percentage discount applied to the product.

#### Response Example
```json
{
  "retval": 0,
  "retdesc": "Success",
  "pages": {
    "name": 1,
    "rows": 100
  },
  "products": [
    {
      "id": 12345,
      "name": "Example Product",
      "price": 99.99,
      "snippets": {
        "info": "A great product for everyday use.",
        "name": "Product Name Snippet"
      },
      "sale_info": {
        "common_base_price": 120.00,
        "common_price_usd": 99.99,
        "common_price_eur": 90.00,
        "common_price_uah": 3500.00
      },
      "sale_percent": 16.67
    }
  ]
}
```
```

--------------------------------

### Offer Object Schema Definition

Source: https://seller.ggsel.net/docs/schemas/offer-object

This JSON schema defines the structure for an offer object, encompassing all details related to a product listing. It includes product identifiers, pricing information, sales and discount details, payment methods, seller information, and preview media. The schema is comprehensive, covering various aspects of a product offer.

```json
{
  "retval": 0,
  "retdesc": "string",
  "product": {
    "id": 0,
    "id_prev": 0,
    "id_next": 0,
    "name": "string",
    "price": 0,
    "currency": "string",
    "url": "string",
    "info": "string",
    "add_info": "string",
    "release_date": "string",
    "agency_fee": "string",
    "agency_sum": "string",
    "agency_id": 0,
    "collection": "string",
    "propertygood": 0,
    "is_available": 0,
    "show_rest": 0,
    "num_in_stock": 0,
    "num_in_lock": 0,
    "prices": {
      "initial": {
        "RUB": 0,
        "USD": 0,
        "EUR": 0
      },
      "default": {
        "RUB": 0,
        "USD": 0,
        "EUR": 0
      }
    },
    "payment_methods": [
      {
        "name": "string",
        "currencies": [
          {
            "currency": "string",
            "code": "string",
            "price": 0,
            "limit": {
              "min": 0,
              "max": 0
            }
          }
        ]
      }
    ],
    "prices_unit": {
      "unit_name": "string",
      "unit_amount": 0,
      "unit_amount_desc": "string",
      "unit_currency": "string",
      "unit_cnt": 0,
      "unit_cnt_min": 0,
      "unit_cnt_max": 0,
      "unit_cnt_desc": "string",
      "unit_fixed": true,
      "unit_only_int": true
    },
    "unique_code_verification": {},
    "preview_imgs": [
      {
        "url": "string",
        "width": 0,
        "height": 0
      }
    ],
    "preview_videos": [
      {
        "url": "string",
        "width": 0,
        "height": 0
      }
    ],
    "type": "string",
    "text": "string",
    "file": "string",
    "category_id": 0,
    "breadcrumbs": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "discounts": [
      {}
    ],
    "units": [
      {}
    ],
    "present": {},
    "gift_commiss": "string",
    "options": [
      {
        "name": 0,
        "label": "string",
        "type": "string",
        "separate_content": 0,
        "required": 0,
        "modifier_visible": 0,
        "variants": [
          {
            "value": 0,
            "text": "string",
            "default": 0,
            "modify": "string",
            "modify_type": "string",
            "modify_value": "string",
            "modify_value_default": "string",
            "num_in_stock": 0,
            "visible": 0
          }
        ]
      }
    ],
    "options_check": 0,
    "statistics": {
      "sales": 0,
      "refunds": 0,
      "good_reviews": 0,
      "bad_reviews": 0
    },
    "seller": {
      "id": 0,
      "name": "string"
    },
    "sale_info": {
      "common_base_price": 0,
      "common_price_usd": 0,
      "common_price_eur": 0,
      "common_price_rur": 0,
      "sale_end": "string",
      "sale_percent": "string"
    }
  }
}
```

--------------------------------

### Offer List Object Structure

Source: https://seller.ggsel.net/docs/schemas/offer-list-object

This section details the structure of the 'offer_list_object' which is returned by the API. It includes information about the result of the operation, pagination details, and a list of products with their respective attributes.

```APIDOC
## Offer List Object Structure

### Description
This object represents a list of offers or products, including metadata about the request and details for each product.

### Method
GET (Assumed, as it describes a list retrieval)

### Endpoint
/websites/seller_ggsel_net_schemas/offer_list_object (Assumed based on project path)

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **count** (integer) - Optional - The number of items per page.

### Request Body
None (Assumed for a GET request)

### Response
#### Success Response (200)
- **retval** (integer) - Result code.
- **retdesc** (string) - Description of the result.
- **page** (integer) - Current page number.
- **count** (integer) - Number of items on the current page.
- **has_next_page** (boolean) - Indicates if there is a next page.
- **has_previous_page** (boolean) - Indicates if there is a previous page.
- **total_count** (integer) - Total number of items available.
- **total_pages** (integer) - Total number of pages available.
- **rows** (object[]) - An array of product objects.
  - **id_goods** (integer) - Product ID.
  - **name_goods** (string) - Product name.
  - **info_goods** (string) - Additional product information.
  - **price** (string) - Product price.
  - **currency** (string) - Price currency.
  - **add_info** (string, nullable) - Additional information.
  - **cnt_sell** (integer) - Number of sales.
  - **cnt_return** (integer) - Number of returns.
  - **cnt_goodresponses** (integer) - Number of good reviews.
  - **cnt_badresponses** (integer) - Number of bad reviews.
  - **price_usd** (number) - Price in USD.
  - **price_eur** (number) - Price in EUR.
  - **price_uah** (number, nullable) - Price in UAH.
  - **price_rur** (number) - Price in RUR.
  - **in_stock** (integer) - Quantity in stock.
  - **num_in_stock** (integer) - Quantity in stock (duplicate field).
  - **visible** (integer) - Product visibility status.
  - **commiss_agent** (string, nullable) - Agent commission.
  - **has_discount** (boolean, nullable) - Indicates if there is a discount.
  - **num_options** (integer) - Number of options.
  - **sale_info** (object) - Sale information.
    - **common_base_price** (number, nullable) - Common base price.
    - **common_price_usd** (number, nullable) - Common price in USD.
    - **common_price_eur** (number, nullable) - Common price in EUR.
    - **common_price_rur** (number, nullable) - Common price in RUR.
    - **sale_end** (string, nullable) - Sale end date.
    - **sale_percent** (string, nullable) - Sale percentage.

#### Response Example
```json
{
  "retval": 0,
  "retdesc": "string",
  "page": 0,
  "count": 0,
  "has_next_page": true,
  "has_previous_page": true,
  "total_count": 0,
  "total_pages": 0,
  "rows": [
    {
      "id_goods": 0,
      "name_goods": "string",
      "info_goods": "string",
      "price": "string",
      "currency": "string",
      "add_info": "string",
      "cnt_sell": 0,
      "cnt_return": 0,
      "cnt_goodresponses": 0,
      "cnt_badresponses": 0,
      "price_usd": 0,
      "price_eur": 0,
      "price_uah": 0,
      "price_rur": 0,
      "in_stock": 0,
      "num_in_stock": 0,
      "visible": 0,
      "commiss_agent": "string",
      "has_discount": true,
      "num_options": 0,
      "sale_info": {
        "common_base_price": 0,
        "common_price_usd": 0,
        "common_price_eur": 0,
        "common_price_rur": 0,
        "sale_end": "string",
        "sale_percent": "string"
      }
    }
  ]
}
```
```

--------------------------------

### reviews_object Structure

Source: https://seller.ggsel.net/docs/schemas/reviews-object

Defines the structure of the reviews_object returned by the API, which includes overall statistics and a list of individual reviews.

```APIDOC
## reviews_object

### Description
Represents the object containing review data, including result codes, pagination information, counts of good and bad reviews, and an array of individual review objects.

### Method
N/A (This describes a data structure, not an endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **retval** (integer) - Result code.
- **retdesc** (string) - Description of the result.
- **totalPages** (integer) - Total number of pages.
- **totalItems** (integer) - Total number of items (reviews).
- **totalGood** (integer) - Total number of good reviews.
- **totalBad** (integer) - Total number of bad reviews.
- **reviews** (object[]) - An array of review objects.
  - **id** (integer) - ID of the review.
  - **info** (string) - Text of the review.
  - **good** (integer) - Product ID.
  - **type** (string) - Type of review.
  - **date** (string) - Date of the review.
  - **invoice_id** (number) - Order ID.
  - **name** (string) - Product name.
  - **comment** (string, nullable) - Seller's comment.
  - **owner_id** (integer) - Reviewer's ID.

#### Response Example
```json
{
  "retval": 0,
  "retdesc": "string",
  "totalPages": 0,
  "totalItems": 0,
  "totalGood": 0,
  "totalBad": 0,
  "reviews": [
    {
      "id": 0,
      "info": "string",
      "good": 0,
      "type": "string",
      "date": "string",
      "invoice_id": 0,
      "name": "string",
      "comment": "string",
      "owner_id": 0
    }
  ]
}
```
```

--------------------------------

### Order Information Retrieval

Source: https://seller.ggsel.net/docs/schemas/info-order

This endpoint provides detailed information about a specific order, including item details, buyer information, payment status, and feedback.

```APIDOC
## GET /api/info_order

### Description
Retrieves detailed information about a specific order.

### Method
GET

### Endpoint
/api/info_order

### Parameters
#### Query Parameters
- **order_id** (integer) - Required - The unique identifier of the order to retrieve.

### Request Example
```
GET /api/info_order?order_id=12345
```

### Response
#### Success Response (200)
- **retval** (integer) - The result code of the operation.
- **retdesc** (string) - A description of the operation's result.
- **content** (object) - Contains the detailed order information.
  - **item_id** (integer, nullable) - The ID of the item in the GGSel system.
  - **content_id** (integer) - The ID of the order.
  - **cart_uid** (string, nullable) - The unique identifier of the cart.
  - **name** (string, nullable) - The name of the item.
  - **amount** (number<float>) - The amount credited to the account (not the full cost).
  - **currency_type** (string) - The type of currency (Default: `USD`).
  - **invoice_state** (integer) - The state of the invoice (1-created, 2-canceled, 3-paid, 4-completed, 5-refunded).
  - **purchase_date** (string<date-time>) - The date of purchase (Example: `2024-01-01T12:00:00Z`).
  - **date_pay** (string<date-time>, nullable) - The date of payment (Example: `2024-01-01T12:30:00Z`).
  - **agent_id** (integer, nullable) - The ID of the agent.
  - **agent_percent** (number, nullable) - The agent's percentage.
  - **agent_fee** (number<float>) - The agent's commission (Default: `0`).
  - **query_string** (string, nullable) - The query string.
  - **unit_goods** (string, nullable) - The unit of measurement for the goods.
  - **cnt_goods** (string, nullable) - The quantity of paid goods.
  - **promo_code** (string, nullable) - The promo code used.
  - **bonus_code** (string, nullable) - The bonus code used.
  - **feedback** (object, nullable) - Customer feedback.
    - **deleted** (boolean) - Whether the feedback is deleted.
    - **feedback** (string) - The text of the feedback.
    - **feedback_type** (string) - The type of feedback (`positive` or `negative`).
    - **comment** (string, nullable) - The seller's response to the feedback.
  - **unique_code_state** (object) - The state of the unique code.
    - **state** (integer, nullable) - The state of the unique code.
    - **date_check** (string<date-time>, nullable) - The date the unique code was checked.
    - **date_delivery** (string<date-time>, nullable) - The date the unique code was delivered, if applicable.
    - **date_confirmed** (string<date-time>, nullable) - The date the unique code was confirmed, if applicable.
    - **date_refuted** (string<date-time>, nullable) - The date the unique code was refuted, if applicable.
  - **options** (object[]) - Product options.
    - **id** (integer) - The ID of the option.
    - **name** (string, nullable) - The name of the option.
    - **user_data** (string) - User-provided data.
    - **user_data_id** (integer, nullable) - The ID of the user data.
  - **buyer_info** (object) - Information about the buyer.
    - **payment_method** (string) - The payment method used.
    - **account** (string) - The buyer's account identifier.
    - **email** (string, nullable) - The buyer's email address.
    - **phone** (string, nullable) - The buyer's phone number.
    - **skype** (string, nullable) - The buyer's Skype ID.
    - **whatsapp** (string, nullable) - The buyer's WhatsApp number.
    - **ip_address** (string, nullable) - The buyer's IP address.
    - **payment_aggregator** (string) - The payment aggregator used.
  - **owner** (integer) - The ID of the owner (seller).
  - **day_lock** (integer) - The number of lock days (Default: `0`).
  - **lock_state** (string) - The state of the lock (Default: `free`).
  - **profit** (number<float>) - The seller's profit.
  - **external_order_id** (string, nullable) - The external order ID (UUID).

#### Response Example
```json
{
  "retval": 0,
  "retdesc": "Success",
  "content": {
    "item_id": 12345,
    "content_id": 67890,
    "cart_uid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "Sample Product",
    "amount": 99.99,
    "currency_type": "USD",
    "invoice_state": 4,
    "purchase_date": "2024-01-01T12:00:00Z",
    "date_pay": "2024-01-01T12:30:00Z",
    "agent_id": 101,
    "agent_percent": 5.0,
    "agent_fee": 4.99,
    "query_string": "?search=product",
    "unit_goods": "pieces",
    "cnt_goods": "1",
    "promo_code": "SUMMER20",
    "bonus_code": null,
    "feedback": {
      "deleted": false,
      "feedback": "Great product!",
      "feedback_type": "positive",
      "comment": "Thank you for your purchase!"
    },
    "unique_code_state": {
      "state": 1,
      "date_check": "2024-01-01T13:00:00Z",
      "date_delivery": null,
      "date_confirmed": "2024-01-01T13:05:00Z",
      "date_refuted": null
    },
    "options": [
      {
        "id": 1,
        "name": "Color",
        "user_data": "Blue",
        "user_data_id": 10
      }
    ],
    "buyer_info": {
      "payment_method": "Credit Card",
      "account": "buyer123",
      "email": "buyer@example.com",
      "phone": "+1234567890",
      "skype": "buyer_skype",
      "whatsapp": "+1234567890",
      "ip_address": "192.168.1.100",
      "payment_aggregator": "Stripe"
    },
    "owner": 505,
    "day_lock": 0,
    "lock_state": "free",
    "profit": 95.00,
    "external_order_id": "uuid-1234-abcd-efgh"
  }
}
```
```

--------------------------------

### Categories Object Schema

Source: https://seller.ggsel.net/docs/schemas/categories-object

Defines the structure of the categories object, including return values, descriptions, and category details.

```APIDOC
## Categories Object Schema

### Description
This schema describes the structure of the `categories_object`, which is used to return category information. It includes a status code, a description of the result, and an array of category objects.

### Method
N/A (This describes a data structure, not an endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **retval** (integer) - The result code. 0 typically indicates success.
- **retdesc** (string) - A description of the result.
- **category** (object[]) - An array of category objects.
  - **id** (integer) - The unique identifier for the category.
  - **name** (string) - The name of the category.
  - **sub** (integer[]) - An array of sub-category IDs.
  - **cnt** (integer, nullable) - The number of products in the category.

#### Response Example
```json
{
  "retval": 0,
  "retdesc": "string",
  "category": [
    {
      "id": 0,
      "name": "string",
      "sub": [
        0
      ],
      "cnt": 0
    }
  ]
}
```
```

--------------------------------

### Last Sales Object

Source: https://seller.ggsel.net/docs/schemas/last-sales-object

Retrieves information about the last sales made on the platform. This includes result codes, descriptions, and a list of sales with invoice details and product information.

```APIDOC
## GET /websites/seller_ggsel_net_schemas/last_sales_object

### Description
Retrieves a list of the most recent sales, including their invoice IDs, dates, and detailed product information such as name and pricing in various currencies.

### Method
GET

### Endpoint
/websites/seller_ggsel_net_schemas/last_sales_object

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **retval** (integer) - Result code of the operation. 0 typically indicates success.
- **retdesc** (string) - Description of the result.
- **sales** (object[]) - An array of sales objects.
  - **invoice_id** (integer) - The unique identifier for the paid invoice.
  - **date** (string) - The date the sale occurred.
  - **product** (object) - An object containing details about the product sold.
    - **id** (integer) - The unique identifier for the product.
    - **name** (string) - The name of the product.
    - **price_rub** (number) - The price of the product in Russian Rubles.
    - **price_usd** (number) - The price of the product in US Dollars.
    - **price_eur** (number) - The price of the product in Euros.
    - **price_uah** (number, nullable) - The price of the product in Ukrainian Hryvnia.

#### Response Example
```json
{
  "retval": 0,
  "retdesc": "Success",
  "sales": [
    {
      "invoice_id": 12345,
      "date": "2023-10-27T10:00:00Z",
      "product": {
        "id": 101,
        "name": "Example Product",
        "price_rub": 1000.00,
        "price_usd": 10.50,
        "price_eur": 9.80,
        "price_uah": 400.00
      }
    }
  ]
}
```
```

--------------------------------

### Balance Object Schema

Source: https://seller.ggsel.net/docs/schemas/balance-object

Defines the structure of the balance object returned by the API, detailing result codes, error messages, and available balance information.

```APIDOC
## Balance Object Schema

### Description
This schema represents the balance information for a seller account. It includes the result code, a description of the result, any errors encountered, and the detailed balance content.

### Method
N/A (This is a schema definition, not an endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (Schema Definition)
- **retval** (integer) - The result code of the operation. 0 typically indicates success.
- **retdesc** (string) - A description of the result.
- **errors** (string[]nullable) - An array of strings detailing any errors encountered. Can be null if no errors.
- **content** (object) - An object containing the balance details.
  - **amount_t_lock** (numbernullable) - The amount of WMT currently locked or unavailable. Can be null.
  - **amount_t_free** (numbernullable) - The amount of WMT currently available. Can be null.
  - **amount_t_plus** (numbernullable) - The amount of WMT that has been topped up with restrictions. Can be null.

#### Response Example
```json
{
  "retval": 0,
  "retdesc": "Success",
  "errors": null,
  "content": {
    "amount_t_lock": 100.50,
    "amount_t_free": 500.75,
    "amount_t_plus": 25.00
  }
}
```
```

--------------------------------

### balance_object Schema Definition

Source: https://seller.ggsel.net/docs/schemas/balance-object

Defines the structure of the balance_object, including fields for return values, descriptions, errors, and content related to locked, free, and replenished WMT amounts. This schema is used to represent balance information.

```json
{
  "retval": 0,
  "retdesc": "string",
  "errors": [
    "string"
  ],
  "content": {
    "amount_t_lock": 0,
    "amount_t_free": 0,
    "amount_t_plus": 0
  }
}
```

--------------------------------

### info_order Schema Structure

Source: https://seller.ggsel.net/docs/schemas/info-order

This JSON object represents the structure of the info_order schema. It outlines the fields and their data types for order details, including item information, buyer details, and payment status. This schema is used to standardize order data retrieval.

```json
{
  "retval": 0,
  "retdesc": "string",
  "content": {
    "item_id": 0,
    "content_id": 0,
    "cart_uid": "string",
    "name": "string",
    "amount": 0,
    "currency_type": "USD",
    "invoice_state": 0,
    "purchase_date": "2024-01-01T12:00:00Z",
    "date_pay": "2024-01-01T12:30:00Z",
    "agent_id": 0,
    "agent_percent": 0,
    "agent_fee": 0,
    "query_string": "string",
    "unit_goods": "string",
    "cnt_goods": "string",
    "promo_code": "string",
    "bonus_code": "string",
    "feedback": {
      "deleted": true,
      "feedback": "string",
      "feedback_type": "positive",
      "comment": "string"
    },
    "unique_code_state": {
      "state": 0,
      "date_check": "2024-07-29T15:51:28.071Z",
      "date_delivery": "2024-07-29T15:51:28.071Z",
      "date_confirmed": "2024-07-29T15:51:28.071Z",
      "date_refuted": "2024-07-29T15:51:28.071Z"
    },
    "options": [
      {
        "id": 0,
        "name": "string",
        "user_data": "string",
        "user_data_id": 0
      }
    ],
    "buyer_info": {
      "payment_method": "string",
      "account": "string",
      "email": "string",
      "phone": "string",
      "skype": "string",
      "whatsapp": "string",
      "ip_address": "string",
      "payment_aggregator": "string"
    },
    "owner": 0,
    "day_lock": 0,
    "lock_state": "free",
    "profit": 0,
    "external_order_id": "string"
  }
}
```

--------------------------------

### Error Response Object

Source: https://seller.ggsel.net/docs/schemas/error-response-object

The standard error response object contains fields for return value and a description of the error.

```APIDOC
## Error Response Object

### Description
This object represents a standard error response from the API. It includes a return value code and a textual description of the error.

### Fields

- **retval** (integer) - The return value code indicating the status of the operation. Typically, 0 indicates success, and non-zero values indicate different types of errors.
- **retdesc** (string) - A human-readable string describing the error that occurred.

### Example Response

```json
{
  "retval": 1001,
  "retdesc": "Invalid API key provided."
}
```
```

--------------------------------

### Unique Code Object Schema

Source: https://seller.ggsel.net/docs/schemas/unique-code-object

This schema defines the structure of the unique_code_object, including result codes, order details, payment information, and associated states and options.

```APIDOC
## Unique Code Object Schema

### Description
This schema defines the structure of the unique_code_object, which contains information about a unique code, its associated order, payment details, and related states and options.

### Method
N/A (This is a schema definition, not an endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```json
{
  "retval": 0,
  "retdesc": "string",
  "inv": 0,
  "id_goods": 0,
  "amount": 0,
  "type_curr": "string",
  "amount_usd": 0,
  "profit": 0,
  "date_pay": "string",
  "email": "string",
  "name_invoice": "string",
  "lang": "string",
  "agent_id": 0,
  "agent_percent": "string",
  "query_string": "string",
  "unit_goods": "string",
  "cnt_goods": "string",
  "promo_code": "string",
  "bonus_code": "string",
  "cart_uid": "string",
  "unique_code_state": {
    "state": 0,
    "date_check": "string",
    "date_delivery": "string",
    "date_confirmed": "string",
    "date_refuted": "string"
  },
  "options": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "variant_id": 0
    }
  ]
}
```

### Response
#### Success Response (200)
- **retval** (integer) - код результата
- **retdesc** (string) - описание результата
- **inv** (integer) - номер заказа
- **id_goods** (integer) - id товара
- **amount** (number) - сумма заказа
- **type_curr** (string) - валюта заказа
- **amount_usd** (number) - сумма заказа в долларах
- **profit** (number) - награда продавца
- **date_pay** (string) - дата оплаты
- **email** (string, nullable) - email покупателя
- **name_invoice** (string) - наименование инвойса
- **lang** (string, nullable) - язык
- **agent_id** (integer, nullable) - id агента
- **agent_percent** (string, nullable) - процент агента
- **query_string** (string, nullable) - строка запроса
- **unit_goods** (string, nullable) - единица оплаченного товара
- **cnt_goods** (string, nullable) - количество оплаченных товаров
- **promo_code** (string, nullable) - промокод, если использовался
- **bonus_code** (string, nullable) - бонусный код, если использовался
- **cart_uid** (string, nullable) - уникальный идентификатор корзины, если использовался
- **unique_code_state** (object) - состояние уникального кода
  - **state** (integer) - состояние уникального кода
  - **date_check** (string, nullable) - дата проверки уникального кода
  - **date_delivery** (string, nullable) - дата доставки, если применимо
  - **date_confirmed** (string, nullable) - дата подтверждения, если применимо
  - **date_refuted** (string, nullable) - дата опровержения, если применимо
- **options** (object[]) - опции товара
  - **id** (integer, nullable) - id опции
  - **name** (string, nullable) - название опции
  - **value** (string, nullable) - значение опции
  - **variant_id** (integer, nullable) - id варианта опции

#### Response Example
```json
{
  "retval": 0,
  "retdesc": "Success",
  "inv": 12345,
  "id_goods": 67890,
  "amount": 100.50,
  "type_curr": "USD",
  "amount_usd": 100.50,
  "profit": 5.00,
  "date_pay": "2023-10-27T10:00:00Z",
  "email": "buyer@example.com",
  "name_invoice": "Order #12345",
  "lang": "en",
  "agent_id": 101,
  "agent_percent": "10%",
  "query_string": "?ref=abc",
  "unit_goods": "piece",
  "cnt_goods": "2",
  "promo_code": "DISCOUNT10",
  "bonus_code": "WELCOME",
  "cart_uid": "cart-xyz789",
  "unique_code_state": {
    "state": 1,
    "date_check": "2023-10-27T10:05:00Z",
    "date_delivery": "2023-10-28T15:00:00Z",
    "date_confirmed": "2023-10-27T11:00:00Z",
    "date_refuted": null
  },
  "options": [
    {
      "id": 1,
      "name": "Color",
      "value": "Blue",
      "variant_id": 5
    }
  ]
}
```
```

--------------------------------

### last_sales_object JSON Schema

Source: https://seller.ggsel.net/docs/schemas/last-sales-object

This JSON schema defines the structure for the 'last_sales_object', which encapsulates sales transaction data. It includes a status code, a descriptive message, and an array of individual sales records, each detailing product information and pricing.

```json
{
  "retval": 0,
  "retdesc": "string",
  "sales": [
    {
      "invoice_id": 0,
      "date": "string",
      "product": {
        "id": 0,
        "name": "string",
        "price_rub": 0,
        "price_usd": 0,
        "price_eur": 0,
        "price_uah": 0
      }
    }
  ]
}
```

--------------------------------

### Error Response Object Schema Definition

Source: https://seller.ggsel.net/docs/schemas/error-response-object

Defines the structure of an error response object. It contains a 'retval' field for the return code and a 'retdesc' field for a textual description of the error. This is a common pattern for API error handling.

```json
{
  "retval": 0,
  "retdesc": "string"
}
```

--------------------------------

### Unique Code Object Schema Definition

Source: https://seller.ggsel.net/docs/schemas/unique-code-object

Defines the structure of the 'unique_code_object' which encapsulates transaction and unique code status information. This schema is used to represent data related to unique codes, including payment details, product information, and state tracking.

```json
{
  "retval": 0,
  "retdesc": "string",
  "inv": 0,
  "id_goods": 0,
  "amount": 0,
  "type_curr": "string",
  "amount_usd": 0,
  "profit": 0,
  "date_pay": "string",
  "email": "string",
  "name_invoice": "string",
  "lang": "string",
  "agent_id": 0,
  "agent_percent": "string",
  "query_string": "string",
  "unit_goods": "string",
  "cnt_goods": "string",
  "promo_code": "string",
  "bonus_code": "string",
  "cart_uid": "string",
  "unique_code_state": {
    "state": 0,
    "date_check": "string",
    "date_delivery": "string",
    "date_confirmed": "string",
    "date_refuted": "string"
  },
  "options": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "variant_id": 0
    }
  ]
}
```

--------------------------------

### Receipts Object JSON Schema

Source: https://seller.ggsel.net/docs/schemas/receipts-object

This JSON schema defines the structure of the 'receipts_object', which includes details about return values, errors, and a list of items representing account operations. It specifies data types and nesting for operation and product details.

```json
{
  "retval": 0,
  "retdesc": "string",
  "errors": [
    "string"
  ],
  "content": {
    "page": 0,
    "count": 0,
    "has_next_page": true,
    "has_previous_page": true,
    "total_count": 0,
    "total_pages": 0,
    "items": [
      {
        "account_operation_id": 0,
        "operation": {
          "id": 0,
          "type": "string",
          "datetime": "string",
          "percent": 0,
          "price": 0,
          "currency": "WMT",
          "on_account": 0
        },
        "owner_id": 0,
        "product": {
          "id": 0,
          "name": [
            {
              "locale": "string",
              "value": "string"
            }
          ],
          "deleted": true
        },
        "code_check_datetime": "string",
        "date_free": "string",
        "free_description": "string",
        "response": "string"
      }
    ]
  }
}
```
Tokens:
Raw