재고조회 개요
지원 method
재고조회 기본 Object 구조
데이터필드 | 자료형 | 설명 |
---|---|---|
shipping_product_id | integer | 출고상품 ID |
total_stock | integer | 총재고 |
receiving_stock | integer | 입고 재고 |
normal_stock | integer | 출고가능 재고 |
order_stock | integer | 출고지시 재고 |
shipping_stock | integer | 출고작업중 재고 |
damaged_stock | integer | 불량 재고 |
return_stock | integer | 반품 재고 |
keeping_stock | integer | 보관 재고 보관존 사용 옵션을 사용할 경우만 노출 |
재고조회(단일)
Request URI | /v2/inventory/stock/{출고상품ID} |
---|---|
Method | GET |
권한 | 고객사, 물류사 |
Response Param
데이터필드 | 자료형 | 설명 |
---|---|---|
code | string(4) | 응답코드 |
message | string(100) | 응답메시지 |
response | dataObject | 재고조회 기본 Object 구성 ▶ |
Request Sample
/v2/inventory/stock/41668
Response Sample
{
"code": "9999",
"message": "ok",
"response": {
"shipping_product_id": "41668",
"total_stock": "20510",
"receiving_stock": "0",
"normal_stock": "20248",
"order_stock": "196",
"shipping_stock": "-179",
"damaged_stock": "0",
"return_stock": "17",
"keeping_stock": "13"
}
}
재고조회(벌크)
Request URI | /v2/inventory/stocks |
---|---|
Method | GET |
권한 | 고객사, 물류사 |
Request Param
데이터필드 | 자료형 | 설명 |
---|---|---|
member_id | integer | 고객사 ID 물류사 권한인 경우 필수 |
shipping_product_ids | integer | 출고상품ID 최대 100개 |
page | integer | 페이지 번호 |
Response Param
데이터필드 | 자료형 | 설명 | |
---|---|---|---|
code | string(4) | 응답코드 | |
message | string(100) | 응답메시지 | |
response | data_list | dataList | 재고조회 기본 Object 구성 ▶ |
total_count | integer | 전체 갯수 | |
total_page | integer | 전체 페이지수 | |
current_page | integer | 현재 페이지 번호 |
Request Sample
/v2/inventory/stocks?member_id=705&shipping_product_ids%5B0%5D=41668&shipping_product_ids%5B1%5D=42355&page=1
Response Sample
{
"code": "9999",
"message": "ok",
"response": {
"total_count": 2,
"total_page": 1,
"current_page": 1,
"data_list": [
{
"shipping_product_id": "41676",
"total_stock": "11436",
"receiving_stock": "30",
"normal_stock": "10319",
"order_stock": "29",
"shipping_stock": "-15",
"damaged_stock": "0",
"return_stock": "25",
"keeping_stock": "1018"
},
{
"shipping_product_id": "41832",
"total_stock": "301",
"receiving_stock": "0",
"normal_stock": "295",
"order_stock": "0",
"shipping_stock": "0",
"damaged_stock": "0",
"return_stock": "6",
"keeping_stock": "0"
}
]
}
}