도매 가격용 API

공개 API를 사용해 스토어의 도매 가격(Wholesale Pricing) 규칙 목록을 가져오세요.

이 문서에서는 공개 API를 사용해 Samita Wholesale 애플리케이션에서 Wholesale Pricing 레코드 목록을 가져오는 방법을 설명해요.

1. 엔드포인트

Wholesale Pricing 목록을 가져오려면 다음 API 엔드포인트를 사용하세요.

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

2. 요청 헤더

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

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

이 헤더 중 하나라도 누락되면 요청이 거부돼요.

3. 요청 파라미터(쿼리 / 본문)

API 요청을 사용자 지정하려면 다음 파라미터를 포함할 수 있어요.

파라미터	설명	필수
`limit`	한 번의 요청으로 반환되는 레코드의 최대 개수를 정의해요	아니요
`query`	제목 또는 ID로 레코드를 검색하는 데 사용해요	아니요
`status`	상태별로 레코드를 필터링하는 데 사용해요	아니요
`sort`	생성 시간순으로 레코드를 정렬하는 데 사용해요	아니요

a. limit

한 번의 요청으로 반환되는 레코드의 최대 개수를 정의해요
숫자 값이어야 해요
최솟값: 1
최댓값: 20
선택 파라미터
비워 두면 기본값은 20이에요

예시:

limit=10

b. query

제목 또는 ID로 레코드를 검색하는 데 사용해요
문자열 값이어야 해요
최대 길이: 255자
선택 파라미터

예시:

query=pricing rule

c. status

상태별로 레코드를 필터링하는 데 사용해요
선택 파라미터
비워 두면 API가 모든 레코드를 반환해요
값을 지정하는 경우 다음 값만 허용돼요.

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

그 외의 값은 거부돼요.

예시:

status=active

d. sort

생성 시간순으로 레코드를 정렬하는 데 사용해요
선택 파라미터
비워 두면 최근에 생성된 레코드부터 정렬돼요
다음 두 값만 허용돼요.

값	설명
`descrease`	최신순으로 정렬
`ascrease`	오래된 순으로 정렬

예시:

sort=descrease

요청 예시:

GET /wholesale-pricing?page=1&limit=20&status=active&sort=descrease

4. API 응답

API는 다음 HTTP 상태 코드 중 하나를 반환해요.

a. 오류 응답

401 – Unauthorized

이 오류는 요청이 올바르게 인증되지 않았을 때 발생해요.

가능한 원인:

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

403 – This action is unauthorized

이 오류는 API 키에 충분한 권한이 없을 때 발생해요.

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

View
Create
Update
Delete

Wholesale Pricing List API를 사용하려면 View 권한이 필요해요.
API 키에 View 권한이 없으면 이 오류가 반환돼요.

429 – Too Many Requests

이 오류는 요청이 허용된 속도 제한을 초과했을 때 발생해요.

현재 속도 제한:

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

이 제한을 초과하면 시스템이 이 오류를 반환해요.

b. 성공 응답

200 – API Success

요청이 유효해요
인증에 성공했어요
데이터가 올바르게 반환돼요
Wholesale Pricing 목록이 JSON 형식으로 제공돼요

API 성공 응답 예시:

[
  {
    "id": 1,
    "title": "New Wholesale Pricing",
    "status": true,
    "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,
        "variant_pricing": true,
        "variants": [
          {
            "id": 46747346763943,
            "discount_groups": [
              {
                "name": "all",
                "type": "percent",
                "value": "10"
              }
            ]
          }
        ]
      }
    ],
    "apply_market": {
      "type": "all",
      "handle": []
    },
    "discount_group": {
      "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"
  }
]

도움이 되었나요?