로그인이 필요합니다.
클라우드 서비스 보급·확산 사업 공급기업 선정! 이용료 최대 80% 지원

개발가이드(ver2.0)

입고예정 개요

예정등록에 의해 상품을 입고처리한다면 먼저 입고예정을 등록합니다.
출고상품 기준으로 입고예정 등록하며, 입고작업이 시작되지 않았다면 입고예정 수정할 수 있습니다.
등록된 입고예정으로 입고작업을 완료했다면, 예정대비입고현황 조회 API로 조회합니다.
모든 입고작업내역을 조회할 경우, 입고작업내역 조회 API로 조회합니다.

사방넷 풀필먼트 매뉴얼: 입고예정 바로가기 ▶, 예정대비 입고현황 바로가기 ▶, 입고작업내역조회 바로가기 ▶

지원 method

입고예정 기본 Object 구조

데이터필드 자료형 설명
receiving_plan_id integer 입고예정 ID
member_id integer 고객사 ID

물류사 권한인 경우 필수

receiving_plan_code string(20) 입고예정코드
plan_date string(8) 입고예정일자

필수, YYYYMMDD 형식

plan_status integer 입고예정 진행상태

1.입고예정, 2.입고검수중, 3.입고완료, 4.입고취소
코드정보 plan_status_code 참고

complete_dt string(8) 완료일

YYYYMMDD 형식

memo string(250) 입고예정메모
add_info1 string(50) 추가정보1
add_info2 string(50) 추가정보2
add_info3 string(50) 추가정보3
add_info4 string(50) 추가정보4
add_info5 string(50) 추가정보5
plan_product_list childDataObject plan_product_object 구성 ▶

필수, 입고예정 리스트

plan_product_object 구조

데이터필드 자료형 설명
shipping_product_id integer 출고상품 ID

필수

quantity integer 예정수량

필수

receiving_plan_product_id integer 입고 예정 상품 ID

조회시만 출력

plan_product_status integer 입고예정 상품 입고상태

- 상태코드는 자동 생성되나 response data object 에는 리턴되지 않음
- 입고예정 조회에서만 노출
- 코드정보 plan_product_status_code 참고

expire_date string(8) 유통기한

YYYYMMDD 형식, 유통기한을 사용하는 상품인 경우에만 입력

make_date string(8) 제조일자

YYYYMMDD 형식, 제조일자를 사용하는 상품인 경우에만 입력

receiving_plan_product_object 구조

데이터필드 자료형 설명
receiving_plan_product_id integer 입고예정상품 ID
shipping_product_id integer 출고상품 ID
plan_quantity integer 예정수량
plan_product_status integer 입고예정 상품 입고상태

1.미입고, 3.부분입고, 5.입고완료, 9.취소
코드정보 plan_status_code 참고

receiving_quantity integer 입고수량

입고예정 등록(단일)

Request URI /v2/inventory/receiving_plan
Method POST
권한 고객사, 물류사

Request Param

데이터필드 자료형 설명
member_id integer 고객사 ID

물류사 권한인 경우 필수

receiving_plan_code string(20) 입고예정코드
plan_date string(8) 입고예정일자

필수, YYYYMMDD 형식

memo string(250) 입고예정메모
add_info1 string(50) 추가정보1
add_info2 string(50) 추가정보2
add_info3 string(50) 추가정보3
add_info4 string(50) 추가정보4
add_info5 string(50) 추가정보5
plan_product_list childDataObject plan_product_object 구성 ▶

필수, 입고예정 리스트

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response receiving_plan_id integer 입고예정 ID
receiving_plan_code string(100) 입고예정코드

Request Sample

{
  "member_id": "70",
  "receiving_plan_code": "20211123_v1",
  "plan_date": "20211130",
  "memo": "memo-002",
  "add_info1": "추가정보 1",
  "add_info2": "추가정보2추가정보2",
  "add_info3": "추가정보 3",
  "add_info4": "추가정보 4",
  "add_info5": "추가정보5",
  "plan_product_list": [
  {
  "shipping_product_id": "43778",
  "quantity": "10",
  "expire_date": "20221030",
  "make_date": "20210830"
  },
  {
  "shipping_product_id": "43778",
  "quantity": "20",
  "expire_date": "20221230",
  "make_date": "20210901"
  },
  {
  "shipping_product_id": "41668",
  "quantity": "70",
  "expire_date": "20231230",
  "make_date": "20201010"
  }
  ]
 }

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
  "receiving_plan_code": "20211110_1",
  "receiving_plan_id": "506"
  }
}

입고예정 수정

Request URI /v2/inventory/receiving_plan/{입고예정ID}
Method PUT
권한 고객사, 물류사

Request Param

데이터필드 자료형 설명
member_id integer 고객사 ID

물류사 권한인 경우 필수

plan_date string(8) 입고예정일자

필수, YYYYMMDD 형식

memo string(250) 입고예정메모
add_info1 string(50) 추가정보1
add_info2 string(50) 추가정보2
add_info3 string(50) 추가정보3
add_info4 string(50) 추가정보4
add_info5 string(50) 추가정보5
plan_product_list childDataObject plan_product_object 구성 ▶

필수

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지

Request Sample

{
  "member_id":70
  "plan_date": "20211125",
  "memo": "memo-002",
  "add_info1": "add_info1",
  "add_info2": "add_info2",
  "add_info3": "add 3",
  "add_info4": "",
  "add_info5": "",
  "plan_product_list": [
  {
  "shipping_product_id": "43778",
  "quantity": "11",
  "expire_date": "20221130",
  "make_date": "20210830"
  },
  {
  "shipping_product_id": "41668",
  "quantity": "55",
  "expire_date": "20231230",
  "make_date": "20201010"
  }
  ]
 }

Response Sample

{
  "code": "9999",
  "message": "ok"
 }

입고예정 취소

Request URI /v2/inventory/receiving_plan/cancel/{입고예정ID}
Method PUT
권한 고객사, 물류사
비고 입고 진행상태가 예정등록인 경우에만 가능

Request Param

데이터필드 자료형 설명
member_id integer 고객사 ID

물류사 권한인 경우 필수

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지

Request Sample

/v2/inventory/receiving_plan/cancel/716?member_id=70

Response Sample

{
 "code": "9999",
 "message": "ok"
 }

입고예정 조회(단일)

Request URI /v2/inventory/receiving_plan/{입고예정ID}
Method GET
권한 고객사, 물류사

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response dataObject 입고예정 Object 구성 ▶

Request Sample

/v2/inventory/receiving_plan/489

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
  "receiving_plan_id": "489",
  "member_id": "70",
  "receiving_plan_code": "20211125_1",
  "plan_date": "20211031",
  "plan_status": "1",
  "complete_dt": "",
  "memo": "memo-002",
  "add_info1": "add_info1 1",
  "add_info2": "add_info2",
  "add_info3": "add 3",
  "add_info4": "",
  "add_info5": "",
  "plan_product_list": [
  {
  "plan_product_status": 1,
  "quantity": 55,
  "expire_date": "20231230",
  "make_date": "",
  "shipping_product_id": 41668
  },
  {
  "plan_product_status": 1,
  "quantity": 22,
  "expire_date": "20221231",
  "make_date": "20210901",
  "shipping_product_id": 43778
  }
  ]
  }
 }

입고예정 조회(벌크)

Request URI /v2/inventory/receiving_plans
Method GET
권한 고객사, 물류사

Request Param

데이터필드 자료형 설명
member_id integer 고객사 ID

물류사 권한인 경우 필수

receiving_plan_code string(20) 입고예정코드
plan_date string(8) 입고예정일자

YYYYMMDD 형식

plan_status integer 입고예정 진행상태

1.입고예정, 2.입고검수중, 3.입고완료, 4.입고취소
코드정보 plan_status_code 참고

page integer 페이지번호

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response total_count integer 전체 갯수
total_page integer 전체 페이지수
current_page integer 현재 페이지 번호
data_list

처리 데이터 리스트

dataList 입고예정 기본 Object 구성 ▶

Request Sample

/v2/inventory/receiving_plans?member_id=70&receiving_plan_code=&plan_date=20210910&plan_status=1&page=1

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
    "total_count": 2,
    "total_page": 1,
    "current_page": 1,
    "data_list": [
      {
        "receiving_plan_id": "462",
        "member_id": "70",
        "receiving_plan_code": "2",
        "plan_date": "20210910",
        "plan_status": "1",
        "complete_dt": "",
        "memo": "",
        "add_info1": "",
        "add_info2": "",
        "add_info3": "",
        "add_info4": "",
        "add_info5": "",
        "plan_product_list": [
          {
            "plan_product_status": 1,
            "quantity": 1,
            "expire_date": "20210902",
            "make_date": "",
            "shipping_product_id": 41670
          }
        ]
      },
      {
        "receiving_plan_id": "446",
        "member_id": "70",
        "receiving_plan_code": "22223",
        "plan_date": "20210910",
        "plan_status": "1",
        "complete_dt": "",
        "memo": "",
        "add_info1": "",
        "add_info2": "",
        "add_info3": "",
        "add_info4": "",
        "add_info5": "",
        "plan_product_list": [
          {
            "plan_product_status": 1,
            "quantity": 1,
            "expire_date": "",
            "make_date": "",
            "shipping_product_id": 41669
          }
        ]
      }
    ]
  }
}

예정대비입고현황 조회

Request URI /v2/inventory/receiving_plan_result/{입고예정ID}
Method GET
권한 고객사, 물류사

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response receiving_plan_id integer 입고예정 ID
receiving_plan_product childDataObject receiving_plan_product_object 구조 ▶

Request Sample

/v2/inventory/receiving_plan_result/553

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
  "receiving_plan_id": "553",
  "receiving_plan_product": [
  {
  "receiving_plan_product_id": "2269",
  "shipping_product_id": "43790",
  "plan_quantity": "1",
  "plan_product_status": "5",
  "receiving_quantity": 1
  },
  {
  "receiving_plan_product_id": "2270",
  "shipping_product_id": "43791",
  "plan_quantity": "1",
  "plan_product_status": "1",
  "receiving_quantity": 0
  }
  ]
  }
 }

입고작업내역 조회(벌크)

Request URI /v2/inventory/receiving_works
Method GET
권한 물류사

Request Param

데이터필드 자료형 설명
member_id integer 고객사 ID

필수

start_dt string(8) 작업시작일

필수, YYYYMMDD 형식

end_dt string(8) 작업종료일

필수, YYYYMMDD 형식

work_type integer 작업구분

1.입고, 3.적치, 5.회송, 7.반품입고, 9.입고취소
코드타입 work_type_code 참고

receiving_type integer 입고분류

1.입고예정검수, 3.개별입고, 5.간편입고, 7.전수검사, 9.엑셀입고
코드타입 receving_type_code 참고

receiving_plan_id integer 입고예정ID
shipping_product_ids array 출고상품ID

최대 100개

page integer 페이지번호

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response total_count integer 전체 갯수
total_page integer 전체 페이지수
current_page integer 현재 페이지 번호
data_list

처리 데이터 리스트

receiving_work_history_id integer 입고작업 히스토리 ID
work_date datetime 작업일시

YYYY-MM-DD HH24:MI:SS 형식

work_type integer 작업구분

1.입고, 3.적치, 5.회송, 7.반품입고, 9.입고취소
코드타입 work_type_code 참고

receiving_plan_id integer 입고예정ID
receiving_type integer 입고분류

1.입고예정검수, 3.개별입고, 5.간편입고, 7.전수검사, 9.엑셀입고
코드타입 receving_type_code 참고

shipping_product_id integer 출고상품 ID
quantity integer 입고수량
make_date string(8) 제조일자

YYYYMMDD 형식

expire_date string(8) 유통기한

YYYYMMDD 형식

location_id integer 로케이션ID
box_quantity integer 박스 수
pallet_quantity integer 팔레트 수
worker_member_id integer 작업자 member_id
work_memo string(1000) 메모

Request Sample

/v2/inventory/receiving_works?member_id=70&start_dt=20211201&end_dt=20211227&work_type=1&receiving_type=1&shipping_product_ids%5B1%5D=41668&shipping_product_ids%5B2%5D=41669

Response Sample

{
    "code": "9999",
    "message": "ok",
    "response": {
        "total_count": 2,
        "total_page": 1,
        "current_page": 1,
        "data_list": [
            {
                "receiving_work_history_id": "83",
                "work_date": "2022-01-20 11:00:01",
                "work_type": "1",
                "receiving_plan_id": "5",
                "receiving_type": "1",
                "shipping_product_id": "5",
                "quantity": "10",
                "make_date": "",
                "expire_date": "20220326",
                "location_id": "2",
                "box_quantity": "1",
                "pallet_quantity": "1",
                "worker_member_id": "1",
                "work_memo": "입고메모 테스트용2"
            },
            {
                "receiving_work_history_id": "82",
                "work_date": "2022-01-20 10:59:45",
                "work_type": "1",
                "receiving_plan_id": "5",
                "receiving_type": "1",
                "shipping_product_id": "4",
                "quantity": "1",
                "make_date": "",
                "expire_date": "",
                "location_id": "2",
                "box_quantity": "1",
                "pallet_quantity": "1",
                "worker_member_id": "1",
                "work_memo": "입고메모 테스트용"
            }
        ]
    }
}
Top