Versions Compared

Version Old Version 1 New Version 2
Changes made by

김상효Mike (Unlicensed)

김상효Mike (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

1. Inventory Quantity

1) Purpose

  • 특정 Product의 Inventory 가용성을 확인하기 위하여 사용하는 API입니다.

  • 1개의 Inventory 는 Depth Combination(Option) 와 연결되어 있습니다.

2) Detail

  • Path Parameter로 입력한 <product_id> 와 일치하는 Product의 Inventory List 를 보여줍니다.

  • 유효한 API Key를 Request Header에 토큰으로 입력해야만 호출 가능합니다.

2. API spec

1) Request

Endpoint

https://prod.ax-cloud.com/v1/channel/inventory/tour

Method

GET

Description

특정 Product의 Inventory를 조회합니다.

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2) Query Parameter

Name

Required

Type

Description

page

X

Integer

Page number(default : 1)

page_size

X

Integer

Size per page(default : 25)

3) Response

Name

Type

Description

status_code

Integer

정상 처리 시 200

data

List[Object]

인벤토리 리스트

id

Integer

인벤토리 아이디

date

Date

날짜

start_time

Time

투어 시작 시간

day_of_the_week

String

요일

is_order

Boolean

판매 유무

max_quantity

Integer

최초 생성 재고

min_quantity

Integer

최소 출발 인원으로 ordered_quantity가 이 값 보다 높아야 Tour가 진행된다.

remain_quantity

Integer

남은 재고

ordered_quantity

Integer

주문 갯수

depth_combination_id

String

인벤토리 연관된 옵션 아이디

4) Response Example

Expand
titleStatus Code : 200 정상 처리 시
Code Block
languagejson
{
  "status_code": 200,
  "data": [
    {
      "id": 1,
      "date": "2023-03-01",
      "start_time": "14:00", 
      "day_of_the_week": "Sunday", 
      "is_order": true, 
      "max_quantity": 25, 
      "min_quantity": 5, 
      "remain_quantity": 10,
      "ordered_quantity": 15
    },
    {
      "id": 2,
      "date": "2023-03-08",
      "start_time": "14:00", 
      "day_of_the_week": "Sunday", 
      "is_order": true, 
      "max_quantity": 25, 
      "min_quantity": 5, 
      "remain_quantity": 20,
      "ordered_quantity": 5
    },
    {
      "id": 3,
      "date": "2023-03-15",
      "start_time": "14:00", 
      "day_of_the_week": "Sunday", 
      "is_order": true, 
      "max_quantity": 25, 
      "min_quantity": 5, 
      "remain_quantity": 11,
      "ordered_quantity": 14
    }
  ]
}

5) Error Spec

Expand
titleStatus Code : 400 Cause: 유효하지 않은 요청 값
Code Block
{'depth_combinations': [ErrorDetail(string='이 필드는 null일 수 없습니다.', code='null')]}
Expand
titleStatus Code : 403 Cause: 유효하지 않은 API Key 혹은 Channel Code
Code Block
{'detail': ErrorDetail(string='이 작업을 수행할 권한(permission)이 없습니다.', code='permission_denied')}

3. Request Example

1) CURL

Code Block
curl -X 'POST' \
  'https://prod.ax-cloud.com/v1/channel/inventory/tour/1' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: gVNVnmaKfzEovZJFYXnxVkZsluzfXFWJDDj9lyq1WuSHuKPpBdgv1bVTiAVrgNqu' \
  -H 'Authorization: Token api_key_secret' \
  -H 'Channel: Code code_secret'

...