수량별 가격용 API

공개 API를 사용해 스토어의 수량별 가격(Volume Pricing) 규칙 목록을 가져오세요.

이 문서에서는 공개 API를 사용해 Volume Pricing 레코드 목록을 가져오는 방법을 설명해요.

1. 엔드포인트

GET https://wholesale.samita.io/api/v1/volume-pricings

이 엔드포인트를 사용하면 필터링 및 정렬 파라미터에 따라 Volume Pricing 레코드 목록을 가져올 수 있어요.

2. 요청 헤더

모든 요청에는 다음 필수 헤더가 포함되어야 해요.

헤더	설명	필수
`X-SAMITA-API-KEY`	Wholesale 앱에서 제공하는 API 키	예
`X-SAMITA-SHOP-URL`	`xxx.myshopify.com` 형식의 Shopify 스토어 도메인	예
`CONTENT-TYPE`	`application/json`이어야 해요	예

필수 헤더가 누락되었거나 올바르지 않으면 요청이 거부돼요.

3. 요청 파라미터

GET 요청은 다음과 같은 선택적 쿼리 파라미터를 지원해요.

a. `limit`

반환되는 레코드의 최대 개수를 정의해요.

숫자여야 해요
최솟값: 1
최댓값: 20
비워 두면 기본값은 20이에요

예시:

?limit=10

b. `query`

제목 또는 ID로 레코드를 필터링하는 데 사용하는 검색 문자열이에요.

문자열이어야 해요
최대 길이: 255자

예시:

?query=pricing rule

c. `status`

상태별로 레코드를 필터링해요.

비워 두면 모든 레코드를 가져와요
값을 지정하는 경우 다음 값만 허용돼요.

값 설명

active 활성 레코드만

draft 초안 레코드만

값	설명
`active`	활성 레코드만
`draft`	초안 레코드만

예시:

?status=active

d. `sort`

생성 시간순으로 레코드를 정렬해요.

비워 둘 수 있어요(기본값: 최신 레코드 우선)
값을 지정하는 경우 다음 중 하나만 허용돼요.
- descrease
- ascrease

예시:

?sort=descrease

전체 요청 예시

GET https://wholesale.samita.io/api/v1/volume-pricings?limit=10&status=active&sort=descrease

4. API 응답

4.1 오류 응답

401 – Unauthorized

인증에 실패하면 반환돼요.

가능한 원인:

스토어 URL 누락
API 키 누락
잘못된 스토어 URL
잘못된 API 키
API 키가 스토어와 일치하지 않음

403 – This action is unauthorized

API 키에 충분한 권한이 없으면 반환돼요.

각 API 키에는 다음 권한을 할당할 수 있어요.

View
Create
Update
Delete

List Volume Pricing API를 사용하려면 View 권한이 필요해요.

429 – Too Many Requests

속도 제한을 초과하면 반환돼요.

현재 제한:

최대 5분당 1회 요청
최대 하루 50회 요청

4.2 성공 응답

200 – API Success

요청이 유효하고 성공적으로 처리되면 반환돼요.

응답은 Volume Pricing 레코드 목록을 JSON 형식으로 반환해요.

API 성공 응답 예시:

[
  {
    "id": 1,
    "title": "New Volume Pricing",
    "status": true,
    "type": "quantity",
    "apply_customer": {
      "type": "all",
      "tags": []
    },
    "exclude_customer": {
      "type": "none",
      "tags": []
    },
    "apply_product": {
      "type": "all",
      "product_ids": [],
      "product_tags": [],
      "collection_ids": [],
      "apply_for_variants": false
    },
    "exclude_product": {
      "type": "none",
      "product_ids": [],
      "collection_ids": []
    },
    "discount_for_variants": [
      {
        "id": 8516448190631,
        "duplicated": false,
        "variant_pricing": true,
        "from_qty": "0",
        "from_amount": "0",
        "to_qty": "10",
        "to_amount": "0",
        "discount_groups": [
          {
            "name": "all",
            "type": "percent",
            "value": "10"
          }
        ],
        "variants": [
          {
            "id": 46747346763943,
            "duplicated": false,
            "from_qty": "0",
            "from_amount": "0",
            "to_qty": "10",
            "to_amount": "0",
            "discount_groups": [
              {
                "name": "all",
                "type": "percent",
                "value": "10"
              }
            ]
          }
        ]
      }
    ],
    "apply_market": {
      "type": "all",
      "handle": []
    },
    "discount_method": "variant",
    "discount_groups": [
      {
        "from_qty": "0",
        "from_amount": "0",
        "to_qty": "10",
        "to_amount": "0",
        "type": "percent",
        "value": "10"
      }
    ],
    "active_date": {
      "types": [],
      "start_at": "",
      "end_at": ""
    },
    "created_at": "2026-01-15T10:00:00",
    "updated_at": "2026-01-15T10:00:00"
  }
]

도움이 되었나요?