Takealot Seller API

https://seller-api.takealot.com/api-docs/
Admin
The Takealot Seller API for Offers enables automated and scalable management of seller offers on the...
Tokens:8,475
Snippets:40
Trust Score:9.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get all offers (v2)

Source: https://seller-api.takealot.com/api-docs/#

Retrieves a list of all offers for the seller.

```APIDOC
## GET /v2/offers

### Description
Get all offers (v2)

### Method
GET

### Endpoint
/v2/offers
```

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

### Get an offer (v2)

Source: https://seller-api.takealot.com/api-docs/#

Retrieves details for a specific offer using its identifier.

```APIDOC
## GET /v2/offers/offer/{identifier}

### Description
Get an offer (v2)

### Method
GET

### Endpoint
/v2/offers/offer/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The unique identifier of the offer.
```

```APIDOC
## GET /v2/offers/offer

### Description
Get an offer (v2)

### Method
GET

### Endpoint
/v2/offers/offer
```

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

### Get all offers (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieve information about your offers on the Takealot platform. This endpoint allows you to fetch a list of your offers, with options for pagination and filtering by offer IDs.

```APIDOC
## GET /v2/offers

### Description
Retrieve information about your offers on the Takealot platform. This endpoint allows you to fetch a list of your offers, with options for pagination and filtering by offer IDs.

### Method
GET

### Endpoint
/v2/offers

### Parameters
#### Query Parameters
- **page_number** (integer) - Optional - The page number to retrieve (starting at 1).
- **page_size** (integer) - Optional - The number of offers per page. Limited to 100.
- **filters** (array of strings) - Deprecated - This field has been deprecated. Please do not use it.
- **sort_key** (string) - Deprecated - This field has been deprecated. Please do not use it. Enum: ["offer_id", "title", "seller_stock", "sales_units", "stock_cpt", "stock_jhb", "stock_total", "stock_cover_cpt", "stock_cover_jhb", "selling_price", "shipping_min", "merchant_warehouse_id", "replen_block"]
- **sort_dir** (string) - Deprecated - This field has been deprecated. Please do not use it. Enum: ["asc", "desc", "ASC", "DESC"]
- **secondary_sort_key** (string) - Deprecated - This field has been deprecated. Please do not use it. Enum: ["title"]
- **secondary_sort_dir** (string) - Deprecated - This field has been deprecated. Please do not use it. Enum: ["asc", "desc", "ASC", "DESC"]
- **is_filtered** (boolean) - Deprecated - This field has been deprecated. Please do not use it.
- **offer_ids** (array of integers) - Optional - A list of offer ids to retrieve.

### Response
#### Success Response (200)
- **offers** (array) - List of offers.
  - **offer_id** (integer) - The unique identifier for the offer.
  - **sku** (string) - The Stock Keeping Unit for the product.
  - **seller_id** (integer) - The unique identifier for the seller.
  - **product_id** (integer) - The unique identifier for the product.
  - **product_name** (string) - The name of the product.
  - **quantity** (integer) - The available quantity of the offer.
  - **reserve_quantity** (integer) - The reserved quantity of the offer.
  - **selling_price** (string) - The selling price of the offer.
  - **cost_price** (string) - The cost price of the offer.
  - **shipping_min** (string) - The minimum shipping fee for the offer.
  - **shipping_max** (string) - The maximum shipping fee for the offer.
  - **status** (string) - The current status of the offer.
  - **title** (string) - The title of the offer.
  - **offer_url** (string) - The URL to the offer on the Takealot platform.
  - **stock_cover** (array) - Stock cover information for each warehouse.
    - **warehouse_id** (integer) - The ID of the warehouse.
    - **stock_cover_days** (integer) - The number of days of stock cover.
  - **sales_units** (array) - Sales units information for each warehouse.
    - **warehouse_id** (integer) - The ID of the warehouse.
    - **sales_units** (integer) - The number of sales units.
  - **discount** (string) - The discount applied to the offer.
  - **discount_shown** (boolean) - Whether the discount is shown.
  - **storage_fee_eligible** (boolean) - Whether the offer is eligible for storage fees.
  - **date_created** (string) - The date the offer was created.
  - **stock_at_takealot_total** (integer) - Total stock at Takealot.
  - **total_excess_takealot_stock** (integer) - Total excess Takealot stock.
  - **stock_at_takealot** (array) - Stock details at Takealot warehouses.
    - **warehouse_id** (integer) - The ID of the warehouse.
    - **stock_count** (integer) - The stock count at the warehouse.
  - **stock_on_way** (array) - Stock details on the way to Takealot warehouses.
    - **warehouse_id** (integer) - The ID of the warehouse.
    - **stock_count** (integer) - The stock count on the way.
  - **total_stock_on_way** (integer) - Total stock on the way.
  - **total_stock_cover** (integer) - Total stock cover across all warehouses.
  - **catalogue_quality_score** (integer) - The catalogue quality score for the offer.
```

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

### GET /{version}/offers/stock_counts

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieve the total number of your offers that have stock at Takealot, as well as the number of offers that have an unbalanced stock level at Takealot.

```APIDOC
## GET /{version}/offers/stock_counts

### Description
Retrieve the total number of your offers that have stock at Takealot, as well as the number of offers that have an unbalanced stock level at Takealot.

### Method
GET

### Endpoint
/{version}/offers/stock_counts

### Parameters
#### Path Parameters
- **version** (string) - Required - The major version of the API, prepended with a v (e.g. v1)

### Response
#### Success Response (200)
- **count** (integer) - The number of offers.

#### Headers
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)
```

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

### Get an offer (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieve information about an individual offer by providing an identifier for the offer. The identifier can be Takealot's Offer ID, the Barcode, or your SKU. Prepend with ID, BARCODE, or SKU respectively. Defaults to Offer ID.

```APIDOC
## GET /offers/{identifier}

### Description
Retrieve information about an individual offer by providing an identifier for the offer.

### Method
GET

### Endpoint
/offers/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - Either Takealot's Offer ID, the Barcode or your SKU for the offer. Prepend with ID, Barcode, or SKU. e.g. ID234, BARCODE3223, SKUDF22. Defaults to Offer ID.

### Responses
#### Success Response (200)
- **schema** - V2Offer

#### Error Responses
- **403** - Forbidden Error
- **404** - Not Found Error
- **500** - Server Error
```

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

### Get offers count (v2)

Source: https://seller-api.takealot.com/api-docs/#

Retrieves the total count of offers for the seller.

```APIDOC
## GET /v2/offers/count

### Description
Get offers count (v2)

### Method
GET

### Endpoint
/v2/offers/count
```

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

### Get Offer by Identifier (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieve information about an individual offer by providing an identifier for the offer. The identifier can be Takealot's Offer ID, the Barcode, or your SKU. Defaults to Offer ID.

```APIDOC
## GET /v2/offers/offer

### Description
Retrieve information about an individual offer by providing an identifier for the offer.

### Method
GET

### Endpoint
/v2/offers/offer

### Parameters
#### Query Parameters
- **identifier** (string) - Required - Either Takealot's Offer ID, the Barcode or your SKU for the offer. Prepend with ID, Barcode, or SKU. e.g. ID234, BARCODE3223, SKUDF22. Defaults to Offer ID.

### Responses
#### Success Response (200)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (403)
- **message** (string)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (404)
- **message** (string)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (500)
- **message** (string)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)
```

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

### Get stock counts

Source: https://seller-api.takealot.com/api-docs/#

Retrieves the count of offers with stock at Takealot and unbalanced stock.

```APIDOC
## GET /{version}/offers/stock_counts

### Description
Get count of offers with stock at Takealot and unbalanced stock at Takealot

### Method
GET

### Endpoint
/{version}/offers/stock_counts

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
```

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

### Get Sales Order Customer Invoices

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieve customer invoices for a specific sales order. This endpoint allows you to get credit notes associated with an order.

```APIDOC
## GET /{version}/sales/orders/{order_id}/customer_invoices

### Description
Get sales orders based on filters passed through. Retrieve customer invoices for a specific sales order.

### Method
GET

### Endpoint
/{version}/sales/orders/{order_id}/customer_invoices

### Parameters
#### Path Parameters
- **version** (string) - Required - The major version of the API, prepended with a v (e.g. v1)
- **order_id** (integer) - Required - The start date for filtering orders

### Response
#### Success Response (200)
- **schema** - Refers to #/definitions/CustomerInvoicesResponse

#### Error Response (default)
- **schema** - Refers to #/definitions/Error
```

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

### Get a batch (v2)

Source: https://seller-api.takealot.com/api-docs/#

Retrieves information about a specific batch using its ID.

```APIDOC
## GET /v2/offers/batch/{batch_id}

### Description
Get batch information (v2)

### Method
GET

### Endpoint
/v2/offers/batch/{batch_id}

### Parameters
#### Path Parameters
- **batch_id** (string) - Required - The ID of the batch to retrieve.
```

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

### Get stock health

Source: https://seller-api.takealot.com/api-docs/#

Retrieves statistics regarding stock health.

```APIDOC
## GET /{version}/offers/stock_health_stats

### Description
Get various statistics regarding your stock health

### Method
GET

### Endpoint
/{version}/offers/stock_health_stats

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
```

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

### Get Batch Information (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Query the current status of a batch and view results if they are available.

```APIDOC
## GET /v2/offers/batch/{batch_id}

### Description
Query the current status of a batch, and view results if they are available.

### Method
GET

### Endpoint
/v2/offers/batch/{batch_id}

### Parameters
#### Path Parameters
- **batch_id** (string) - Required - The ID of the batch you have submitted, provided to you by Takealot.

### Response
#### Success Response (200)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (403)
- **message** (string)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)
```

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

### Get Offers Count (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieve the total number of your offers on the Takealot platform. This endpoint can optionally filter offers by their status.

```APIDOC
## GET /v2/offers/count

### Description
Retrieve the total number of your offers on the Takealot platform (optionally filtered by offer status).

### Method
GET

### Endpoint
/v2/offers/count

### Parameters
#### Query Parameters
- **offer_statuses** (array) - Optional - A list of offer statuses to filter by. Example - ?offer_statuses=Buyable,Not Buyable. Allowed values: Buyable, Not Buyable, Disabled by Seller, Disabled by Takealot

### Response
#### Success Response (200)
- **count** (integer) - The total number of offers matching the criteria.

#### Response Example
{
  "count": 150
}

#### Error Responses
- **403 Forbidden Error**: Returned if the request is forbidden.
- **500 Server Error**: Returned if a server error occurs.
```

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

### Get Sales Orders

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieve information about your sales orders on the Takealot platform. This endpoint allows filtering orders by date and other criteria.

```APIDOC
## GET /{version}/sales/orders

### Description
Get sales orders based on filters passed through. This endpoint retrieves information about your sales orders on the Takealot platform.

### Method
GET

### Endpoint
/{version}/sales/orders

### Parameters
#### Path Parameters
- **version** (string) - Required - The major version of the API, prepended with a v (e.g. v1)

#### Query Parameters
- **start_date** (string) - Required - The start date for filtering orders
- **end_date** (string) - Required - The end date for filtering orders
- **sku** (string) - Optional - The SKU for filtering orders
- **product_title** (string) - Optional - The product title for filtering orders
```

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

### Create a batch (v2)

Source: https://seller-api.takealot.com/api-docs/#

Creates a batch for offers.

```APIDOC
## POST /v2/offers/batch

### Description
Create a batch (v2)

### Method
POST

### Endpoint
/v2/offers/batch
```

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

### Create Offer

Source: https://seller-api.takealot.com/api-docs/swagger.json

Creates a new offer for a product. This endpoint allows sellers to list new products for sale on Takealot.

```APIDOC
## POST /v2/offers

### Description
Creates a new offer for a product.

### Method
POST

### Endpoint
/v2/offers

### Parameters
#### Request Body
- **sku** (string) - Required - The unique SKU of the offer. Please send us a unique sku whose length is less than 256 characters.
- **selling_price** (integer) - Required - The price at which the offer will sell for on Takealot (promotion prices will be prioitised). Please ensure you supply us with a positive whole number.
- **rrp** (integer) - Required - The original price of the offer. Please ensure you supply us with a positive whole number.
- **leadtime_days** (integer) - Required - The leadtime days of the offer. You can remove leadtime days from your offer by sending through -1.
- **leadtime_stock** (array of object) - Required - The leadtime stock of the offer. Please ensure that the merchant_warehouse_id is correct, found at https://seller.takealot.com/api/seller-api/offers and send a positive whole number for the quantity.
  - **merchant_warehouse_id** (integer) - Required - The ID of the merchant warehouse.
  - **quantity** (integer) - Required - The quantity of stock available at the merchant warehouse.

### Request Example
{
  "sku": "NEW-SKU-123",
  "selling_price": 150,
  "rrp": 200,
  "leadtime_days": 3,
  "leadtime_stock": [
    {
      "merchant_warehouse_id": 1,
      "quantity": 10
    }
  ]
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of offer creation.

#### Response Example
{
  "message": "Offer created successfully."
}
```

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

### Create Batch (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Create or update multiple offers by submitting a batch. Batches larger than 10k items will be rejected.

```APIDOC
## POST /v2/offers/batch

### Description
Create or update multiple offers by submitting a batch. Please note there is a 10k size limit - batches larger than this limit will be rejected.

### Method
POST

### Endpoint
/v2/offers/batch

### Parameters
#### Request Body
- **offers** (array) - Required - An array of V2OfferBatchCreateUpdate objects.

### Response
#### Success Response (200)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (400)
- **message** (string)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (403)
- **message** (string)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (500)
- **message** (string)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)
```

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

### Create Offer by Identifier Query v2

Source: https://seller-api.takealot.com/api-docs/swagger.json

Creates an offer for a product variant using its Barcode. This is the v2 version of the offer creation endpoint.

```APIDOC
## POST /offers/v2

### Description
Creates an offer by providing the variant's Barcode.

### Method
POST

### Endpoint
/offers/v2

### Parameters
#### Query Parameters
- **identifier** (string) - Required - The Barcode for the variant to create an offer against. It is not required to prepend BARCODE.

#### Request Body
- **offer** (V2OfferSingleCreate) - Required - Offer details for creation.

### Response
#### Success Response (200)
- **offer** (V2OfferUpdateSuccessResponse) - Details of the created offer.

#### Headers
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Responses
- **400**: Bad Request Error
- **403**: Forbidden Error
- **404**: Not Found Error
- **500**: Server Error
```

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

### Create an offer (v2)

Source: https://seller-api.takealot.com/api-docs/#

Creates a new offer using its identifier.

```APIDOC
## POST /v2/offers/offer/{identifier}

### Description
Create an offer (v2)

### Method
POST

### Endpoint
/v2/offers/offer/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The unique identifier for the offer to be created.
```

```APIDOC
## POST /v2/offers/offer

### Description
Create an offer (v2)

### Method
POST

### Endpoint
/v2/offers/offer
```

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

### Create Offer by Identifier (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Creates an offer for a product variant using its Barcode. This endpoint allows for the creation of new offers or updates to existing ones.

```APIDOC
## POST /offers/v2/{identifier}

### Description
Create an offer by providing the variant's Barcode.

### Method
POST

### Endpoint
/offers/v2/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The Barcode for the variant to create an offer against. It is not required to prepend BARCODE.

#### Request Body
- **offer** (V2OfferSingleCreate) - Required - The offer details for the creation.

### Responses
#### Success Response (200)
- **V2OfferUpdateSuccessResponse** - The response schema for a successful offer creation or update.

#### Error Responses
- **400** - Bad Request Error: Indicates an issue with the request payload or parameters.
- **403** - Forbidden Error: Indicates that the authenticated user does not have permission to perform the action.
- **404** - Not Found Error: Indicates that the specified resource (e.g., variant) was not found.
- **500** - Server Error: Indicates an unexpected error on the server.
```

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

### View sales

Source: https://seller-api.takealot.com/api-docs/#

Retrieves information about sales on the Takealot platform.

```APIDOC
## GET /{version}/sales

### Description
Retrieve information about your sales on the Takealot platform

### Method
GET

### Endpoint
/{version}/sales

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
```

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

### V2OfferWarehouseStock Object Definition

Source: https://seller-api.takealot.com/api-docs/swagger.json

Defines the structure for stock available at a specific Takealot warehouse.

```APIDOC
## V2OfferWarehouseStock Object

### Description
Represents the quantity of stock available for an offer at a specific Takealot warehouse.

### Properties
- **warehouse** (object) - Information about the warehouse.
  - **warehouse_id** (integer) - The ID of the warehouse.
  - **name** (string) - The name of the warehouse.
- **quantity_available** (integer) - The quantity of the item available at this warehouse.
```

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

### Update an offer (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Update an offer by providing an identifier for the offer. The identifier can be Takealot's Offer ID, the Barcode, or your SKU. Prepend with ID, BARCODE, or SKU respectively. Defaults to Offer ID.

```APIDOC
## PATCH /offers/{identifier}

### Description
Update an offer by providing an identifier for the offer.

### Method
PATCH

### Endpoint
/offers/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - Either Takealot's Offer ID, the Barcode or your SKU for the offer. Prepend with ID, BARCODE, or SKU. e.g. ID234, BARCODE3223, SKUDF22. Defaults to Offer ID.

#### Request Body
- **offer** (object) - Required - Schema: V2OfferSingleUpdate

### Responses
#### Success Response (200)
- **schema** - V2OfferUpdateSuccessResponse

#### Error Responses
- **400** - Bad Request Error
- **403** - Forbidden Error
```

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

### V2OfferBatch Object Definition

Source: https://seller-api.takealot.com/api-docs/swagger.json

Defines the structure for a batch of offers, including status and results of the batch operation.

```APIDOC
## V2OfferBatch Object

### Description
Represents the result of a batch operation on offers, including overall status and details for each offer processed.

### Properties
- **batch_id** (string) - The unique identifier for the batch operation.
- **status** (object) - The status of the batch operation.
  - **description** (string) - A description of the batch status.
  - **id** (integer) - The ID code for the batch status.
- **result** (array) - An array of results for each offer processed in the batch.
  - **items** (object)
    - **validation_errors** (array) - A list of validation errors encountered for the offer.
      - **items** (object)
        - **message** (string) - The error message.
        - **code** (string) - The error code.
    - **offer** (object) - Details of the processed offer.
      - **selling_price** (integer)
      - **rrp** (integer)
      - **leadtime_days** (integer)
      - **leadtime_stock** (array) - See `V2OfferLeadtimeStock` definition.
      - **stock_at_takealot** (array) - See `V2OfferWarehouseStock` definition.
      - **status** (string) - The current status of the offer.
      - **sku** (string) - The SKU of the offer.
      - **offer_id** (integer) - The unique ID of the offer.
```

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

### View sales orders

Source: https://seller-api.takealot.com/api-docs/#

Retrieves information about sales orders on the Takealot platform.

```APIDOC
## GET /{version}/sales/orders

### Description
Retrieve information about your sales orders on the Takealot platform

### Method
GET

### Endpoint
/{version}/sales/orders

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
```

```APIDOC
## GET /{version}/sales/orders/{order_id}/customer_invoices

### Description
Retrieve information about your sales orders on the Takealot platform

### Method
GET

### Endpoint
/{version}/sales/orders/{order_id}/customer_invoices

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
- **order_id** (string) - Required - The ID of the order.
```

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

### Offer Object Definition

Source: https://seller-api.takealot.com/api-docs/swagger.json

Defines the structure of an offer object, including its properties and their types.

```APIDOC
## Offer Object

### Description
Represents a product offer with various attributes that can be managed through the API.

### Properties
- **offer_id** (integer) - The unique ID of the offer.
- **sku** (string) - The unique SKU of the offer. Max length: 256 characters.
- **barcode** (string) - The barcode that exists in Takealot's Catalogue. Used to create a new offer.
- **selling_price** (integer) - The price at which the offer will sell on Takealot. Must be a positive whole number.
- **rrp** (integer) - The original price of the offer. Must be a positive whole number.
- **leadtime_days** (integer) - The lead time in days for the offer. Set to -1 to remove lead time.
- **leadtime_stock** (array) - The lead time stock for the offer. Each item must include `merchant_warehouse_id` and a positive `quantity`.
  - **items** (object)
    - **merchant_warehouse_id** (integer)
    - **quantity** (integer)
- **status_action** (string) - The action to perform on the offer's status. Allowed values: `Disable`, `Re-enable`.
```

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

### Update Offer by Identifier (v2)

Source: https://seller-api.takealot.com/api-docs/swagger.json

Update an offer by providing an identifier for the offer. The identifier can be Takealot's Offer ID, the Barcode, or your SKU. Defaults to Offer ID.

```APIDOC
## PATCH /v2/offers/offer

### Description
Update an offer by providing an identifier for the offer.

### Method
PATCH

### Endpoint
/v2/offers/offer

### Parameters
#### Query Parameters
- **identifier** (string) - Required - Either Takealot's Offer ID, the Barcode or your SKU for the offer. Prepend with ID, BARCODE, or SKU. e.g. ID234, BARCODE3223, SKUDF22. Defaults to Offer ID.

#### Request Body
- **offer** (V2OfferSingleUpdate) - Required - Offer details for the update.

### Responses
#### Success Response (200)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (400)
- **message** (string)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)

#### Error Response (403)
- **x-RateLimit-Limit** (integer)
- **x-RateLimit-Remaining** (integer)
- **x-RateLimit-Reset** (string)
```

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

### V2Offers Object Definition

Source: https://seller-api.takealot.com/api-docs/swagger.json

Defines the structure for a paginated list of offers.

```APIDOC
## V2Offers Object

### Description
Represents a paginated response containing a list of offers.

### Properties
- **total_results** (integer) - The total number of offers available.
- **page_size** (integer) - The number of offers returned in this page.
```

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

### View Sales

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieves a list of sales with pagination information. This endpoint is useful for analyzing sales trends and performance.

```APIDOC
## GET /sales

### Description
Retrieves a paginated list of sales.

### Method
GET

### Endpoint
/sales

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of sales to return.
- **offset** (integer) - Optional - The number of sales to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **page_summary** (PageSummary) - Summary information about the pagination of the results.
- **sales** (array of Sale) - A list of sales objects.

#### Response Example
{
  "page_summary": {
    "limit": 10,
    "offset": 0,
    "total_count": 100
  },
  "sales": [
    {
      "shipment_id": 12345,
      "shipment_state_id": 1,
      "po_number": 67890,
      "shipment_name": "Order #12345",
      "offer_id": 111,
      "product_title": "Example Product",
      "takealot_url_mobi": "http://m.takealot.com/example-product/111",
      "sku": "SKU123",
      "tsin": 456,
      "order_id": 789,
      "order_item_id": 101,
      "quantity": 1,
      "selling_price": 100.00,
      "dc": "JHB",
      "customer_dc": "CPT",
      "order_date": "2023-10-27T10:00:00Z",
      "sale_status": true,
      "promotion": false,
      "customer": "John Doe",
      "stock_source_region": "South Africa"
    }
  ]
}
```

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

### Update an offer (v2)

Source: https://seller-api.takealot.com/api-docs/#

Updates an existing offer using its identifier.

```APIDOC
## PATCH /v2/offers/offer/{identifier}

### Description
Update an offer (v2)

### Method
PATCH

### Endpoint
/v2/offers/offer/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The unique identifier of the offer to update.
```

```APIDOC
## PATCH /v2/offers/offer

### Description
Update an offer (v2)

### Method
PATCH

### Endpoint
/v2/offers/offer
```

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

### Sales summary

Source: https://seller-api.takealot.com/api-docs/#

Retrieves a summary of sales over various date ranges.

```APIDOC
## GET /{version}/sales/summary

### Description
Retrieve information about your sales summary over various date ranges

### Method
GET

### Endpoint
/{version}/sales/summary

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
```

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

### View Sales Orders

Source: https://seller-api.takealot.com/api-docs/swagger.json

Retrieves a list of sales orders with pagination information. This endpoint is useful for tracking sales performance and order details.

```APIDOC
## GET /salesorders

### Description
Retrieves a paginated list of sales orders.

### Method
GET

### Endpoint
/salesorders

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of sales orders to return.
- **offset** (integer) - Optional - The number of sales orders to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **page_summary** (PageSummary) - Summary information about the pagination of the results.
- **sales** (array of Sale) - A list of sales order objects.

#### Response Example
{
  "page_summary": {
    "limit": 10,
    "offset": 0,
    "total_count": 100
  },
  "sales": [
    {
      "shipment_id": 12345,
      "shipment_state_id": 1,
      "po_number": 67890,
      "shipment_name": "Order #12345",
      "offer_id": 111,
      "product_title": "Example Product",
      "takealot_url_mobi": "http://m.takealot.com/example-product/111",
      "sku": "SKU123",
      "tsin": 456,
      "order_id": 789,
      "order_item_id": 101,
      "quantity": 1,
      "selling_price": 100.00,
      "dc": "JHB",
      "customer_dc": "CPT",
      "order_date": "2023-10-27T10:00:00Z",
      "sale_status": true,
      "promotion": false,
      "customer": "John Doe",
      "stock_source_region": "South Africa"
    }
  ]
}
```

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

### SalesSummaryResponse Object Definition

Source: https://seller-api.takealot.com/api-docs/swagger.json

Defines the structure for the response containing sales summary data.

```APIDOC
## SalesSummaryResponse Object

### Description
Contains a summary of sales data.

### Properties
- **sales_summary** (array) - An array of `SaleSummary` objects, each detailing a sales period.
  - **items** (object) - See `SaleSummary` definition.
```

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

### Update Offer

Source: https://seller-api.takealot.com/api-docs/swagger.json

This endpoint allows sellers to update existing offers. You can modify selling price, RRP, lead time, stock, and status. Ensure all provided data is accurate.

```APIDOC
## PUT /offers/v2/offers

### Description
Updates an existing offer with new details.

### Method
PUT

### Endpoint
/offers/v2/offers

### Request Body
- **sku** (string) - Required - The unique SKU of the offer. Please send us a unique sku whose length is less than 256 characters.
- **selling_price** (integer) - Required - The price at which the offer will sell for on Takealot (promotion prices will be prioitised). Please ensure you supply us with a positive whole number.
- **rrp** (integer) - Required - The original price of the offer. Please ensure you supply us with a positive whole number.
- **leadtime_days** (integer) - Required - The leadtime days of the offer. You can remove leadtime days from your offer by sending through -1.
- **leadtime_stock** (array) - Required - The leadtime stock of the offer. Please ensure that the merchant_warehouse_id is correct, found at https://seller.takealot.com/api/seller-api/offers and send a positive whole number for the quantity.
  - **merchant_warehouse_id** (integer) - Required
  - **quantity** (integer) - Required
- **status_action** (string) - Optional - This allows you to set the status of the offer to 'Disabled by Seller' (by sending through Disable) or 'Buyable' or 'Not Buyable' (by sending through Re-enable), depending on what rules are satisfied.
  - Enum: ["Disable", "Re-enable"]

### Request Example
```json
{
  "sku": "TEST-SKU-123",
  "selling_price": 15000,
  "rrp": 20000,
  "leadtime_days": 3,
  "leadtime_stock": [
    {
      "merchant_warehouse_id": 1234,
      "quantity": 10
    }
  ],
  "status_action": "Disable"
}
```

### Response
#### Success Response (200)
- **offer** (object) - Details of the updated offer.
  - **tsin_id** (integer)
  - **offer_id** (integer)
  - **sku** (string)
  - **barcode** (string)
  - **product_label_number** (string)
  - **selling_price** (integer)
  - **rrp** (integer)
  - **leadtime_days** (integer)
  - **leadtime_stock** (array of objects)
    - **merchant_warehouse** (object)
      - **warehouse_id** (integer)
      - **name** (string)
    - **quantity_available** (integer)
- **validation_errors** (array of objects) - List of any validation errors encountered.
  - **message** (string)
  - **code** (string)

#### Response Example
```json
{
  "offer": {
    "tsin_id": 1000001,
    "offer_id": 2000001,
    "sku": "TEST-SKU-123",
    "barcode": "1234567890123",
    "product_label_number": "PLN12345",
    "selling_price": 15000,
    "rrp": 20000,
    "leadtime_days": 3,
    "leadtime_stock": [
      {
        "merchant_warehouse": {
          "warehouse_id": 1234,
          "name": "Cape Town Warehouse"
        },
        "quantity_available": 10
      }
    ]
  },
  "validation_errors": []
}
```
```
Tokens:
Raw