Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 28 Next »

1. Inventory Quantity

1) Purpose

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

  • 가용성을 확인하면 해당 인벤토리를 구매 가능 여부를 판단할 수 있습니다.

2) Detail

  • 인벤토리는 Depth Combination(Option) 와 연결되어 있습니다.

  • 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/{product_code}

Method

GET

Description

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

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2) Path Parameter

Name

Required

Type

Description

product_code

O

String

Product ID(UUID)

3) 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

Object

{option_code}

List[Object]

상품의 옵션에 해당하는 식별자

inventory_code

String

인벤토리 코드

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

 Status Code : 200 정상 처리 시
{
  "status_code": 200,
  "data": {
      "1e0bd91f-989a-45e7-8e1c-4fe2d4231ae5": [
      {
        "inventory_code": "d50a6594-3457-4e87-afe1-435ca13b8cdd",
        "date": "2023-03-01",
        "start_time": "14:00", 
        "day_of_the_week": "Sunday", 
        "is_order": true,
        "max_quantity": 25, 
        "min_quantity": 5,
        "remain_quantity": 15, 
        "ordered_quantity": 10
      },
      {
        "inventory_code": "374bf54a-d7c1-4ad3-a95a-32aa3e7212ae",
        "date": "2023-03-08",
        "start_time": "14:00", 
        "day_of_the_week": "Sunday", 
        "is_order": true, 
        "max_quantity": 25, 
        "min_quantity": 5,
        "remain_quantity": 5, 
        "ordered_quantity": 20
      },
      {
        "inventory_code": "5e77bcf2-9026-4263-847b-a8a4a84b5613",
        "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

 Status Code : 404 Cause: 유효하지 않은 요청 값
{'message': '찾을 수 없습니다.'}
 Status Code : 403 Cause: 유효하지 않은 API Key 혹은 Channel Code
{'detail': ErrorDetail(string='이 작업을 수행할 권한(permission)이 없습니다.', code='permission_denied')}

3. Request Example

1) CURL

curl -X 'POST' \
  'https://prod.ax-cloud.com/v1/channel/inventory/tour/5a8b34ec-1a32-4b70-a5ba-8f2c81ec4c09' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token api_key_secret' \
  -H 'Channel: Code code_secret'
  -d '{
  "status_code": 200,
  "data": {
      "1e0bd91f-989a-45e7-8e1c-4fe2d4231ae5": [
      {
        "inventory_code": "d50a6594-3457-4e87-afe1-435ca13b8cdd",
        "date": "2023-03-01",
        "start_time": "14:00", 
        "day_of_the_week": "Sunday", 
        "is_order": true,
        "max_quantity": 25, 
        "min_quantity": 5,
        "remain_quantity": 15, 
        "ordered_quantity": 10
      },
      {
        "inventory_code": "374bf54a-d7c1-4ad3-a95a-32aa3e7212ae",
        "date": "2023-03-08",
        "start_time": "14:00", 
        "day_of_the_week": "Sunday", 
        "is_order": true, 
        "max_quantity": 25, 
        "min_quantity": 5,
        "remain_quantity": 5, 
        "ordered_quantity": 20
      },
      {
        "inventory_code": "5e77bcf2-9026-4263-847b-a8a4a84b5613",
        "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
      }
    ]
  }
}'

  • No labels