コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

出荷取得

GET
/order_shipments/{order_shipment_id}
curl --request GET \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/order_shipments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

出荷を取得します。

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
order_shipment_id
required
string format: uuid

出荷ID

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
OrderGroupShipmentResponse
object
id

出荷ID

string format: uuid
orderGroupId

受注グループID

string format: uuid
shipmentStatusId

配送ステータスID

string format: uuid
deliveryRuleId

配送ルールID

string format: uuid
deliveryCompanyId

配送会社ID

string format: uuid
nullable
deliveryMethodId

配送方法ID

string format: uuid
deliveryTemperatureId

配送温度帯ID

string format: uuid
nullable
isGeneralDelivery

普通郵便フラグ

boolean
desiredDeliveryOn

配達希望日[YYYY-MM-DD]

string format: date
nullable
estimatedShippingOn

出荷予定日[YYYY-MM-DD]

string format: date
nullable
shippingOn

出荷日[YYYY-MM-DD]

string format: date
nullable
estimatedDeliveryOn

配達予定日[YYYY-MM-DD]

string format: date
nullable
deliveryAt

配達日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
invoiceArticle

品名

string
nullable
attention

注意事項

string
nullable
note

備考

string
nullable
weight

重量

integer
size

サイズ

0 以上 9999999999.99 以下の小数2桁。商品の size が null の場合や集計対象が無い場合は 0.00 になります（null にはなりません）。

string
default: 0.00
deliveryCost

配送費用

string
deliveryFeeNoTax

配送料（税抜）

string
deliveryFeeTaxRate

配送料税率（%）

integer
deliveryPiecesNumber

口数

integer
nullable
recipientId

配送先ID

string format: uuid
recipientCustomerId

取引先ID

string format: uuid
nullable
recipientCompanyName

届け先会社名

string
nullable
recipientDepartment

届け先部署名

string
nullable
recipientLastName

届け先姓

string
recipientFirstName

届け先名

string
recipientLastNameFurigana

届け先姓（フリガナ）

string
nullable
recipientFirstNameFurigana

届け先名（フリガナ）

string
nullable
recipientCountryCode
CountryCode

国コード（ISO 3166-1 numeric）

  • 392: 日本

国コード一覧（ISO 3166-1 numeric）

integer
recipientZipCode

届け先郵便番号

string
recipientPrefectureCode
PrefectureCode

都道府県コード（JIS X 0401）

More information

integer
>= 1 <= 47
recipientAddress01

届け先住所1

string
recipientAddress02

届け先住所2

string
nullable
recipientAddress03

届け先住所3

string
nullable
recipientTelephoneNumber

届け先電話番号

string
recipientFaxNumber

届け先FAX番号

string
nullable
recipientEmail

届け先メールアドレス

string format: email
nullable
recipientDisplayName

届け先表示名

string
nullable
orderShipmentDetails

配送明細

Array<object>
OrderGroupShipmentDetailResponse
object
id

出荷明細ID

string format: uuid
orderShipmentId

出荷ID

string format: uuid
orderDetailId

受注明細ID

string format: uuid
orderDetailNumber

受注明細番号

string
unitPriceNoTax

単価（税抜）

string
quantity

数量

integer
subtotalNoTax

小計（税抜）

string
isAllocated

引当済フラグ

boolean
allocatedQuantity

引当数量

integer
orderShipmentTracks

配送追跡

Array<object>
OrderGroupShipmentTrackResponse
object
id

配送追跡ID

string format: uuid
orderShipmentId

出荷ID

string format: uuid
trackingNumber

追跡番号

string
Examples
Exampledefault
{
  "id": "12345678-1234-1234-1234-1234567890b2",
  "orderGroupId": "12345678-1234-1234-1234-1234567890ab",
  "shipmentStatusId": "12345678-1234-1234-1234-1234567890c3",
  "deliveryRuleId": "12345678-1234-1234-1234-1234567890d4",
  "deliveryCompanyId": "12345678-1234-1234-1234-1234567890e5",
  "deliveryMethodId": "12345678-1234-1234-1234-1234567890f6",
  "deliveryTemperatureId": null,
  "isGeneralDelivery": false,
  "desiredDeliveryOn": null,
  "estimatedShippingOn": null,
  "shippingOn": "2026-03-27",
  "estimatedDeliveryOn": "2026-03-31",
  "deliveryAt": null,
  "invoiceArticle": null,
  "attention": null,
  "note": null,
  "weight": 452,
  "size": "835.00",
  "deliveryCost": "0",
  "deliveryFeeNoTax": "0",
  "deliveryFeeTaxRate": 10,
  "deliveryPiecesNumber": null,
  "recipientId": "12345678-1234-1234-1234-1234567890g7",
  "recipientCustomerId": null,
  "recipientCompanyName": "株式会社スマレジ",
  "recipientDepartment": "quibusdam",
  "recipientLastName": "すまれじ",
  "recipientFirstName": "太郎",
  "recipientLastNameFurigana": "スマレジ",
  "recipientFirstNameFurigana": "タロウ",
  "recipientCountryCode": 392,
  "recipientZipCode": "5555555",
  "recipientPrefectureCode": 13,
  "recipientAddress01": "大阪市中央区",
  "recipientAddress02": "大繁盛物産ビル 65F",
  "recipientAddress03": null,
  "recipientTelephoneNumber": "00011112222",
  "recipientFaxNumber": "00033334444",
  "recipientEmail": "sample@example.com",
  "recipientDisplayName": "omnis",
  "orderShipmentDetails": [
    {
      "id": "12345678-1234-1234-1234-1234567890h8",
      "orderShipmentId": "12345678-1234-1234-1234-1234567890b2",
      "orderDetailId": "12345678-1234-1234-1234-1234567890st",
      "orderDetailNumber": "1-001",
      "unitPriceNoTax": "100.00",
      "quantity": 1,
      "subtotalNoTax": "100.00",
      "isAllocated": true,
      "allocatedQuantity": 0
    }
  ],
  "orderShipmentTracks": [
    {
      "id": "12345678-1234-1234-1234-1234567890i9",
      "orderShipmentId": "12345678-1234-1234-1234-1234567890b2",
      "trackingNumber": "track123456789"
    }
  ]
}

404

Section titled “404”

指定されたIDのリソースが見つからない場合

Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Example
{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}