{ "opencollection": "1.0.0", "info": { "name": "Kurly Logistics Services (KLS) Open API Authentication 배송운영 정책 API", "version": "1.3.12" }, "items": [ { "info": { "name": "배송운영 정책", "type": "folder" }, "items": [ { "info": { "name": "배송서비스 목록 조회 API", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/api/delivery-agency/v1/delivery-policies" }, "docs": "주소만 입력하면 화주사의 배송대행 정책에 매칭되는 가용 운영정책을 가장 빠른 배송 가능일 기준으로 조회합니다. deliveryDate는 입력하지 않습니다. oms-order-operation 이 가장 빠른 배송 예정일을 자동 결정하여 응답합니다. 응답은 화주사의 배송대행 정책(샛별/하루)에 매칭되는 권역·택배사 옵션만 반환합니다. operation의 night 와 관련된 서비스는 현재 준비중입니다. 서비스 이용 가능 시기에 따로 안내가 있을 예정이니 참고 부탁드립니다." }, { "info": { "name": "운송장 출력 정보 다건 조회", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/v1/invoices/print-data" }, "docs": "송장 번호 목록으로 송장 출력에 필요한 정보를 조회합니다. 택배사(courier) 값에 따라 invoice 객체의 스키마가 달라집니다. 요청한 화주사 본인의 송장만 반환됩니다. 미존재하거나 다른 화주사 소유인 번호는 응답에서 제외됩니다." }, { "info": { "name": "주문 다건 조회 - 판매처 주문번호", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/v1/orders" }, "docs": "판매처 주문번호 목록으로 주문 정보를 조회합니다. 요청한 화주사 본인의 주문만 반환됩니다. 미존재하거나 다른 화주사 소유인 주문번호는 응답에서 제외됩니다." }, { "info": { "name": "주문 등록", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/v1/orders" }, "docs": "배송대행 주문을 등록합니다. 한 번에 최대 20건까지 등록할 수 있으며, 각 주문의 성공/실패 결과를 개별적으로 반환합니다." }, { "info": { "name": "주문 다건 조회 - 요청 식별 키", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/v1/orders/by-request-keys" }, "docs": "요청 식별 키 목록으로 주문 정보를 조회합니다. 요청한 화주사 본인의 주문만 반환됩니다. 미존재하거나 다른 화주사 소유인 요청 식별 키는 응답에서 제외됩니다." }, { "info": { "name": "주문 취소 - 요청 식별 키", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/v1/orders/cancel/by-request-key" }, "docs": "입력한 요청 식별 키에 해당하는 주문을 단건 취소합니다. 취소할 수 없는 상태(출고·배송 진행 등)면 취소되지 않습니다. 이미 취소된 주문은 성공으로 간주(멱등)합니다." }, { "info": { "name": "주문 취소 - 판매처 주문번호", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/v1/orders/cancel" }, "docs": "입력한 판매처 주문번호에 해당하는 배송대행 주문을 취소합니다. 동일 판매처 주문번호의 건이 여러 개면 함께 처리되며, 하나라도 취소할 수 없는 주문(출고·배송 진행 등)이 있으면 전체가 취소되지 않습니다. 이미 취소된 주문은 성공으로 간주(멱등)합니다." }, { "info": { "name": "상품 목록 조회", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/v1/goods/skus" }, "docs": "상품 목록을 조회하는 API입니다." }, { "info": { "name": "상품 등록", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/v1/goods/skus" }, "docs": "상품을 등록하는 API입니다. (부분 성공 시에도 200 OK와 내역 반환)" }, { "info": { "name": "상품 수정", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/v1/goods/skus" }, "docs": "상품을 수정하는 API입니다. (부분 성공 시에도 200 OK와 내역 반환)" }, { "info": { "name": "판매 채널 상품 매핑 리스트 조회", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/v1/goods/sales-channel-mapping" }, "docs": "판매 채널 상품 매핑 리스트를 조회하는 API입니다." }, { "info": { "name": "판매 채널 상품 매핑 등록", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/v1/goods/sales-channel-mapping" }, "docs": "판매 채널 상품 매핑을 등록하는 API입니다." }, { "info": { "name": "판매 채널 상품 매핑 수정", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/v1/goods/sales-channel-mapping" }, "docs": "판매 채널 상품 매핑을 수정하는 API입니다." }, { "info": { "name": "거래명세서 다운로드", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/openapi/v1/receiving-request/specification" }, "docs": "입고 요청 코드를 기반으로 거래명세서(PDF)를 다운로드합니다." }, { "info": { "name": "입고 요청 등록", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/openapi/v1/receiving-request" }, "docs": "입고 요청을 등록하는 API입니다." }, { "info": { "name": "입고 요청 취소", "type": "http" }, "http": { "method": "PATCH", "url": "https://{host}/openapi/v1/receiving-request/cancel" }, "docs": "등록된 입고 요청을 취소하는 API입니다." }, { "info": { "name": "입고 플랜 조회", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/openapi/v1/receiving-request/plans/search" }, "docs": "입고 요청할 상품 및 수량 정보를 바탕으로 입고 플랜 목록을 조회하는 API입니다." }, { "info": { "name": "리포트 조회", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/openapi/v1/receiving-request/reports/search" }, "docs": "입고 리포트 목록을 조회합니다." }, { "info": { "name": "상품 입고 현황 조회", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/openapi/v1/receiving-request/items/status/search" }, "docs": "다양한 조건을 통해 상품별 입고 현황을 조회합니다." }, { "info": { "name": "입고 요청 목록 조회", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/openapi/v1/receiving-request/search" }, "docs": "입고 요청 목록을 조회하는 API입니다." }, { "info": { "name": "입하라벨지 다운로드", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/openapi/v1/receiving-request/receiving-label/print" }, "docs": "입고 요청 코드를 기반으로 입하라벨지(PDF)를 다운로드합니다. 상품코드를 지정하지 않으면 해당 입고 요청의 전체 상품 라벨을 대상으로 합니다. 다운로드 가능 상태(확인대기/입고대기/입고중)에서만 다운로드할 수 있습니다." }, { "info": { "name": "로트별 수불부 조회", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/v1/lot-ledgers" }, "docs": "날짜 범위 내 로트별 수불부를 조회합니다. goodsCode 가 존재하는 경우 최대 조회가능 날짜 31일, 존재하지 않는 경우 최대 7일" }, { "info": { "name": "상품별 수불부 조회", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/v1/ledgers" }, "docs": "날짜 범위 내 상품별 수불부를 조회합니다. goodsCode 가 존재하는 경우 최대 조회가능 날짜 31일, 존재하지 않는 경우 최대 7일" }, { "info": { "name": "재고 조회", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/v1/inventories" }, "docs": "재고 조회 API 입니다." }, { "info": { "name": "주문 다건 등록 V2", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/api/fulfillment/v2/orders/bulk" }, "docs": "주문 다건 등록 V2" }, { "info": { "name": "주문 단건 등록 V2", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/api/fulfillment/v2/orders" }, "docs": "주문 단건 등록 V2" }, { "info": { "name": "주문 조회", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/api/fulfillment/v1/orders" }, "docs": "등록된 주문 정보를 조회하는 API입니다." }, { "info": { "name": "주문 다건 취소 V2", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/api/fulfillment/v2/orders/bulk/cancel" }, "docs": "주문 다건 취소 V2" }, { "info": { "name": "주문 단건 취소 V2", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/api/fulfillment/v2/orders/cancel" }, "docs": "주문 단건 취소 V2" }, { "info": { "name": "주문이행계획 다건 조회", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/api/fulfillment/v1/operation-plans/bulk" }, "docs": "여러 주문이행계획을 한 번에 조회하는 API입니다." }, { "info": { "name": "주문이행계획 단건 조회", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/api/fulfillment/v1/operation-plans" }, "docs": "주문이행계획 단건 조회 API입니다." } ] } ], "bundled": true }