반품 입고 목록

* 핸디봇에 등록된 반품, 맞교환 CS를 통해 실제 입고된 건을 조회합니다. * 핸디봇에 등록하는 CS 유형은 반품, 맞교환, 재발송 세 가지입니다. * 반품 입고 목록은 반품, 맞교환 등록 CS 중 실제 입고된 건만 출력합니다.

Header

curl -X GET "https://api.poomgo.com/open-api/cs"
-H "Content-Type: application/json"
-H "accept: application/json"
-H "Authorization: KEY"
Shell
복사

Request (Query String)

필드명	타입	설명	Optional
page	number	요청 페이지	O
pageSize	number	요청 페이지	O
status	enum	DRAFT = 준비됨 PROCESSING = 진행중 DONE = 완료됨 CANCELED = 취소됨	O
returnStatus	string[]	DRAFT = 준비됨 REQUESTED = 요청됨 AT_PARTNER = 고객사 회수됨 AT_CENTER = 센터 회수됨 FAILED = 회수 실패 CANCELED = 취소됨	O
serial	string	CS 번호	O
originalInvoiceCode	string	원송장 송장번호	O
originalOrderCode	string	원송장 주문번호	O
returnInvoiceCode	string	회수송장 송장번호	O
createdAtGte	date	접수일자 시작일	O
createdAtLte	date	접수일자 마지막일	O
canceledAtGte	date	취소일자 시작일	O
canceledAtLte	date	취소일자 마지막일	O
returnRequestedAtGte	date	회수요청일 시작	O
returnRequestedAtLte	date	회수요청일 마지막	O
returnDoneAtGte	date	회수완료일자 시작	O
returnDoneAtLte	date	회수완료일자 마지막	O
returnRecipientName	string	회수 수취인명	O
returnRecipientAddress	string	회수 수취인 주소	O
returnRecipientPostcode	string	회수 수취인 우편번호	O
returnRecipientMobile	string	회수 수취인 전화번호	O
returnSenderName	string	회수 송화인명	O
returnSenderAddress	string	회수 송화인 주소	O
returnSenderPostcode	string	회수 송화인 우편번호	O
returnSenderMobile	string	회수 송화인 전화번호	O
returnResourceName	string	회수 품목명	O
returnResourceCode	string	회수 품목 바코드	O
returnResourceItemNumber	string	회수 품목 고객사 관리번호	O

https://api.poomgo.com/open-api/cs?page=1&pageSize=10
JSON
복사
호출 파라미터 예시 1

Request

필드명	타입	설명
returnInvoices	object[]	반품 정보
typeCodeKey	string	• CSTICKET_TYPE_INCOMING: 재고반영(양품 O) • CSTICKET_TYPE_DISUSE: 센터보관(양품 X) • CSTICKET_TYPE_OUTGOING: 반출
csLogs	object[]	반품 관련 로그

{
  “pageSize”: 20,
  “rowCount”: 1,
  “totalPage”: 1,
  “total”: 1,
  “data”: [
    {
      “id”: 334,
      “createdBy”: 1983,
      “updatedBy”: 1983,
      “createdAt”: “2019-06-28T09:22:03.810Z”,
      “updatedAt”: “2019-06-28T09:22:03.810Z”,
      “deletedAt”: null,
      “serial”: “CS_RT_190628_000014”,
      “status”: “DRAFT”,
      “type”: “RETURN”,
      “partnerId”: 5414,
      “brandId”: null,
      “channelId”: 4,
      “logisticsCenterId”: 3338,
      “organizationId”: 3170,
      “originalLogisticsContractId”: 3268,
      “originalInvoiceId”: null,
      “originalInvoiceCode”: null,
      “originalOrderId”: null,
      “originalOrderCode”: “20171208_000001",
      “description”: null,
      “isCarryOut”: false,
      “carryOutListId”: null,
      “tagId”: null,
      “canceledAt”: null,
      “returnInvoices”: [
        {
          “id”: 305,
          “createdBy”: 1983,
          “updatedBy”: 1983,
          “createdAt”: “2019-06-28T09:22:03.850Z”,
          “updatedAt”: “2019-06-28T09:22:03.850Z”,
          “deletedAt”: null,
          “csId”: 334,
          “status”: “DRAFT”,
          “code”: null,
          “logisticsContractId”: 09987,
          “recipientName”: “1”,
          “recipientAddress”: “1”,
          “recipientPostcode”: “1”,
          “recipientMobile”: “1”,
          “recipientPhone”: null,
          “senderName”: “”,
          “senderAddress”: “”,
          “senderPostcode”: “”,
          “senderMobile”: “”,
          “senderPhone”: null,
          “senderAdditional”: null,
          “traceData”: null,
          “enclosedCash”: null,
          “deliveryMessage”: null,
          “description”: null,
          “requestedAt”: null,
          “doneAt”: null,
          “deliveryPrice”: null,
          “airFare”: null,
          “ferryFare”: null,
          “deliveryAt”: null,
          “collectionAt”: null,
          “isExemption”: false,
          “returnInvoiceItems”: [
            {
              “id”: 1013,
              “createdBy”: 1,
              “updatedBy”: 1,
              “createdAt”: “2024-01-02T09:07:37.832Z”,
              “updatedAt”: “2024-02-13T08:09:50.869Z”,
              “deletedAt”: null,
              “returnInvoiceId”: 1000,
              “partnerId”: 1,
              “brandId”: null,
              “partnerResourceId”: 99122,
              “resourceName”: “사용자2”,
              “resourceCode”: “88779648215468”,
              “resourceItemNumber”: null,
              “originalQuantity”: 3,
              “returnQuantity”: 4
            }
          ]
        }
      ],
      “replacementInvoices”: [],
      “tag”: null,
      “csLogs”: [
        {
          “id”: 1662,
          “type”: “RETURN”,
          “description”: “회수 송장을 생성했습니다.“,
          “createdAt”: “2019-06-28T09:22:03.859Z”
        },
        {
          “id”: 1661,
          “type”: “CS”,
          “description”: “CS를 생성했습니다.“,
          “createdAt”: “2019-06-28T09:22:03.832Z”
        }
      ]
    }
  ]
}
JSON
복사
결과 예시