Skip to main content
Shipments API를 사용하면 계정의 배송 목록을 조회하고, ID 또는 배송이 이행하는 결제로 배송을 조회하고, 결제에 추적 번호를 연결하고, 기존 배송의 추적 번호를 업데이트할 수 있습니다.

엔드포인트

속성

string
필수
ship_ 접두사가 붙은 배송 ID입니다.
string
필수
이 배송을 소유한 계정으로, biz_ 접두사가 붙습니다.
string | null
필수
이 배송에 대해 감지된 운송사입니다. 추적 업데이트로 운송사가 식별되기 전까지는 null입니다.
object[]
필수
이 배송의 운송사 스캔 기록으로, 가장 오래된 스캔이 먼저 나옵니다. 운송사가 첫 스캔을 보고하기 전까지는 비어 있습니다.

속성

string | null
필수
운송사가 스캔을 기록한 위치로, 예를 들어 PHILADELPHIA, PA입니다. 운송사가 위치를 보내지 않으면 null입니다.
string | null
필수
운송사의 스캔 설명으로, 예를 들어 Departed USPS Regional Facility입니다. 운송사가 설명을 보내지 않으면 null입니다.
string
필수
이 운송사 스캔이 대응되는 배송 상태입니다.사용 가능한 옵션: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string | null
필수
운송사가 스캔을 기록한 시각으로, ISO 8601 타임스탬프입니다. 운송사가 스캔 시각을 보내지 않으면 null입니다.
string
필수
배송이 생성된 일시입니다(ISO 8601).
string
필수
이 배송이 이행하는 결제로, pay_ 접두사가 붙습니다.
string
필수
이 배송의 현재 배송 상태입니다.사용 가능한 옵션: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string
필수
배송 진행 상황을 조회하는 데 사용되는 운송사 지정 추적 번호입니다.
string
필수
이 배송의 진행 상황을 추적할 수 있는 고객용 URL입니다.
string
필수
배송이 마지막으로 업데이트된 일시입니다(ISO 8601).
Shipment