For the complete documentation index, see llms.txt. This page is also available as Markdown.

Volume Pricing with other API methods

This document explains how to retrieve and delete Volume Pricing records using the Public API.


WHOLESALE PRICING GET API

1. Endpoint

To retrieve a specific Volume Pricing record:

GET https://wholesale.samita.io/api/v1/volume-pricings/{id}
  • {id} is the ID of the Volume Pricing record

  • The ID can be obtained from the app interface

  • Do not include the “#” symbol when using the ID

Example:


2. Request Headers

All GET requests must include the following required headers:

Header
Description
Required

X-SAMITA-API-KEY

API key provided in the Wholesale app

Yes

X-SAMITA-SHOP-URL

Shopify shop domain in format xxx.myshopify.com

Yes

CONTENT-TYPE

Must be application/json

Yes

If any of these headers are missing, the request will be rejected.


3. Request Body

  • The GET API does not require a request body

  • Only the {id} parameter in the URL is required


4. API Response

4.1 Error Responses

401 – Unauthorized

This error occurs when authentication fails.

Possible reasons:

  • Missing shop URL

  • Missing API key

  • Incorrect shop URL

  • Incorrect API key

  • API key does not match the provided shop


403 – This action is unauthorized

This error occurs when:

  • The API key does not have View permission

  • The provided ID does not exist

  • Insufficient access rights for the API key

Each API key can be assigned the following permissions:

  • View

  • Create

  • Update

  • Delete

The GET API requires View permission.


429 – Too Many Requests

This error occurs when the rate limit is exceeded.

Current limits:

  • Maximum 1 request per 5 minutes

  • Maximum 50 requests per day


4.2 Success Response

200 – API Success

  • The request is valid

  • The record is successfully retrieved

  • Response is returned in JSON format

Example:


WHOLESALE PRICING DELETE API

1. Endpoint

To delete an existing Volume Pricing record:

  • {id} is the ID of the Volume Pricing record

  • The ID must be a valid existing record ID

Example:


2. Request Headers

All DELETE requests must include the following required headers:

Header
Description
Required

X-SAMITA-API-KEY

API key provided in the Wholesale app

Yes

X-SAMITA-SHOP-URL

Shopify shop domain in format xxx.myshopify.com

Yes

CONTENT-TYPE

Must be application/json

Yes


3. Request Body

  • The DELETE API does not require a request body

  • Only the {id} in the endpoint URL is required


4. API Response

4.1 Error Responses

401 – Unauthorized

Returned when authentication fails.

Possible reasons:

  • Missing shop URL

  • Missing API key

  • Incorrect shop URL

  • Incorrect API key

  • API key does not match the shop


403 – This action is unauthorized

This error occurs when:

  • The API key does not have Delete permission

  • The provided ID does not exist

  • The API key does not have sufficient access rights

The DELETE API requires Delete permission.


429 – Too Many Requests

Returned when the request exceeds the allowed rate limit.

Rate limits:

Limit Type
Value

Request frequency

1 request per 5 minutes

Daily limit

50 requests per day


4.2 Success Response

200 – API Success

  • The Wholesale Pricing record is successfully deleted

  • No content or a confirmation message may be returned

Example:

Last updated

Was this helpful?