Skip to main content
GET
/
api
/
v1
/
delivery
/
orders
/
{orderIdOrCode}
배송 정보 조회
curl --request GET \
  --url https://api.steppay.kr/api/v1/delivery/orders/{orderIdOrCode} \
  --header 'Secret-Token: <api-key>'
[
  {
    "purpose": "ORDER",
    "direction": "TO_BUYER",
    "status": "PREPARING",
    "deliveryCharge": 123,
    "recipient": {
      "name": "<string>",
      "phone": "<string>",
      "postcode": "<string>",
      "address1": "<string>",
      "address2": "<string>"
    },
    "deliveryItemList": [
      {
        "orderItemCode": "<string>",
        "movedTo": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "tracking": {
      "courier": "DOOR_TO_DOOR",
      "trackingNumber": "<string>",
      "message": "<string>",
      "departedAt": "2023-11-07T05:31:56Z",
      "arrivedAt": "2023-11-07T05:31:56Z"
    }
  }
]

Authorizations

Secret-Token
string
header
required

Path Parameters

orderIdOrCode
string
required

Response

OK

purpose
enum<string>
required
Available options:
ORDER,
EXCHANGE_COLLECTION,
EXCHANGE_DELIVERY,
EXCHANGE_REJECTED,
RETURN_COLLECTION,
RETURN_REJECTED
direction
enum<string>
required
Available options:
TO_BUYER,
TO_SELLER
status
enum<string>
required
Available options:
PREPARING,
SUSPENDED,
ON_THE_WAY,
COMPLETED
deliveryCharge
integer<int64>
required
recipient
object
required
deliveryItemList
object[]
required
createdAt
string<date-time>
tracking
object