{
"openapi": "3.0.0",
"components": {
"examples": {},
"headers": {},
"parameters": {},
"requestBodies": {},
"responses": {
"SystemMaintenance": {
"description": "システムメンテナンス中です。この応答のリクエストは未受付です。復旧後に呼び出し元から再送してください。",
"headers": {
"Retry-After": {
"description": "再試行までの待機秒数。復旧時刻を保証しません。",
"schema": {
"type": "integer",
"example": 60
}
},
"Cache-Control": {
"schema": {
"type": "string",
"example": "no-store"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
},
"example": {
"message": "現在システムメンテナンス中です。終了後に再実行してください。"
}
}
}
},
"CompanySuspended": {
"description": "会社のサービス停止中です。有効なキーでも業務処理を実行しません。",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"code"
],
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "string",
"enum": [
"company_suspended"
]
}
}
},
"example": {
"message": "Service is suspended for this company.",
"code": "company_suspended"
}
}
}
}
},
"schemas": {
"POTypeCodeValue": {
"type": "string",
"enum": [
"112",
"510"
],
"description": "発注区分\n112: 入庫\n510: 返品"
},
"PlanPoStateCodeValue": {
"type": "string",
"description": "発注ステータスコード\n130：入荷待ち\n150：荷受済み\n155：格納待ち"
},
"ShippingPointCodeValue": {
"type": "string",
"enum": [
"100",
"110",
"120",
"130"
],
"description": "【出荷場所コード】
\n100：Yashio Dock
\n110：Chiba Dock
\n120：Central Chiba Dock
\n130：Central Chiba Dock 5F
"
},
"ExtItemPOPlanResponseDto": {
"properties": {
"itemPONo": {
"type": "string",
"description": "入荷ID"
},
"poTypeCode": {
"$ref": "#/components/schemas/POTypeCodeValue"
},
"poTypeName": {
"type": "string",
"description": "発注区分名"
},
"poStateCode": {
"$ref": "#/components/schemas/PlanPoStateCodeValue",
"description": "発注ステータスコード（ジェネリクスで動的に変えられる）"
},
"poStateName": {
"type": "string",
"description": "発注ステータス名"
},
"itemNo": {
"type": "string",
"description": "商品コード"
},
"itemName": {
"type": "string",
"description": "商品名"
},
"poNo": {
"type": "string",
"nullable": true,
"description": "発注番号"
},
"lotNo": {
"type": "string",
"nullable": true,
"description": "ロット番号"
},
"qtyPO": {
"type": "integer",
"format": "int32",
"description": "入荷実績数量"
},
"qtyPOOrigin": {
"type": "integer",
"format": "int32",
"description": "入荷予定数量"
},
"datePOEntry": {
"type": "string",
"nullable": true,
"description": "発注登録日"
},
"dateDelivPromise": {
"type": "string",
"description": "入荷予定日"
},
"dateDelivFinish": {
"type": "string",
"description": "入荷実績日"
},
"dateExpiration": {
"type": "string",
"nullable": true,
"description": "有効期限"
},
"supplierCode": {
"type": "string",
"description": "仕入先コード"
},
"supplierName": {
"type": "string",
"description": "仕入先名"
},
"supplierNameS": {
"type": "string",
"nullable": true,
"description": "仕入先略称"
},
"siteCode": {
"type": "string",
"nullable": true,
"description": "倉庫コード"
},
"siteName": {
"type": "string",
"nullable": true,
"description": "倉庫名"
},
"shippingPointCode": {
"allOf": [
{
"$ref": "#/components/schemas/ShippingPointCodeValue"
}
],
"nullable": true
},
"shippingPointName": {
"type": "string",
"nullable": true,
"description": "出荷場所名"
},
"arrivalTransporterTypeCode": {
"type": "string",
"nullable": true,
"description": "入荷運送会社コード"
},
"arrivalTransporterTypeName": {
"type": "string",
"nullable": true,
"description": "入荷運送会社名"
},
"arrivalTransInvNo": {
"type": "string",
"nullable": true,
"description": "入荷伝票番号"
},
"whTaskCode": {
"type": "string",
"nullable": true,
"description": "付帯作業コード(複数ある場合カンマ区切り)"
},
"whTaskName": {
"type": "string",
"nullable": true,
"description": "付帯作業名"
},
"packingID": {
"type": "string",
"nullable": true,
"description": "梱包ID"
},
"dateShippingDeadline": {
"type": "string",
"nullable": true,
"description": "出荷期限日"
},
"qualityOrigin": {
"type": "string",
"nullable": true,
"description": "予定格付け区分"
},
"quality": {
"type": "string",
"nullable": true,
"description": "実績格付け区分"
},
"qualityReason": {
"type": "string",
"nullable": true,
"description": "格付け理由"
},
"headText10": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目1"
},
"headText11": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目2"
},
"headText12": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目3"
},
"headText13": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目4"
}
},
"required": [
"itemPONo",
"poTypeCode",
"poTypeName",
"poStateCode",
"poStateName",
"itemNo",
"itemName",
"poNo",
"lotNo",
"qtyPO",
"qtyPOOrigin",
"datePOEntry",
"dateDelivPromise",
"dateDelivFinish",
"dateExpiration",
"supplierCode",
"supplierName",
"supplierNameS",
"siteCode",
"siteName",
"shippingPointCode",
"shippingPointName",
"arrivalTransporterTypeCode",
"arrivalTransporterTypeName",
"arrivalTransInvNo",
"whTaskCode",
"whTaskName",
"packingID",
"dateShippingDeadline"
],
"type": "object",
"additionalProperties": false
},
"ExtGetItemPOPlanDto": {
"properties": {
"itemPONo": {
"type": "string",
"description": "発注番号",
"maxLength": 7
},
"itemNo": {
"type": "string",
"description": "商品コード",
"maxLength": 100
},
"supplierCode": {
"type": "string",
"description": "仕入先コード",
"maxLength": 20
},
"datePOEntryFrom": {
"type": "string",
"description": "発注登録日（開始）yyyy-MM-dd形式",
"maxLength": 10
},
"datePOEntryTo": {
"type": "string",
"description": "発注登録日（終了）yyyy-MM-dd形式",
"maxLength": 10
},
"arrivalTransInvNo": {
"type": "string",
"description": "入荷伝票番号",
"maxLength": 300
},
"poNo": {
"type": "string",
"description": "発注番号",
"maxLength": 20
},
"packingID": {
"type": "string",
"description": "梱包ID",
"maxLength": 7
},
"page": {
"type": "integer",
"format": "int32",
"description": "page",
"default": 1
},
"limit": {
"type": "integer",
"format": "int32",
"description": "limit",
"default": 5000
}
},
"type": "object",
"additionalProperties": false
},
"ArrivalPoStateCodeValue": {
"type": "string",
"description": "発注ステータスコード\n200：入荷済み"
},
"ExtItemPOArrivalResponseDto": {
"properties": {
"itemPONo": {
"type": "string",
"description": "入荷ID"
},
"poTypeCode": {
"$ref": "#/components/schemas/POTypeCodeValue"
},
"poTypeName": {
"type": "string",
"description": "発注区分名"
},
"poStateCode": {
"$ref": "#/components/schemas/ArrivalPoStateCodeValue",
"description": "発注ステータスコード（ジェネリクスで動的に変えられる）"
},
"poStateName": {
"type": "string",
"description": "発注ステータス名"
},
"itemNo": {
"type": "string",
"description": "商品コード"
},
"itemName": {
"type": "string",
"description": "商品名"
},
"poNo": {
"type": "string",
"nullable": true,
"description": "発注番号"
},
"lotNo": {
"type": "string",
"nullable": true,
"description": "ロット番号"
},
"qtyPO": {
"type": "integer",
"format": "int32",
"description": "入荷実績数量"
},
"qtyPOOrigin": {
"type": "integer",
"format": "int32",
"description": "入荷予定数量"
},
"datePOEntry": {
"type": "string",
"nullable": true,
"description": "発注登録日"
},
"dateDelivPromise": {
"type": "string",
"description": "入荷予定日"
},
"dateDelivFinish": {
"type": "string",
"description": "入荷実績日"
},
"dateExpiration": {
"type": "string",
"nullable": true,
"description": "有効期限"
},
"supplierCode": {
"type": "string",
"description": "仕入先コード"
},
"supplierName": {
"type": "string",
"description": "仕入先名"
},
"supplierNameS": {
"type": "string",
"nullable": true,
"description": "仕入先略称"
},
"siteCode": {
"type": "string",
"nullable": true,
"description": "倉庫コード"
},
"siteName": {
"type": "string",
"nullable": true,
"description": "倉庫名"
},
"shippingPointCode": {
"allOf": [
{
"$ref": "#/components/schemas/ShippingPointCodeValue"
}
],
"nullable": true
},
"shippingPointName": {
"type": "string",
"nullable": true,
"description": "出荷場所名"
},
"arrivalTransporterTypeCode": {
"type": "string",
"nullable": true,
"description": "入荷運送会社コード"
},
"arrivalTransporterTypeName": {
"type": "string",
"nullable": true,
"description": "入荷運送会社名"
},
"arrivalTransInvNo": {
"type": "string",
"nullable": true,
"description": "入荷伝票番号"
},
"whTaskCode": {
"type": "string",
"nullable": true,
"description": "付帯作業コード(複数ある場合カンマ区切り)"
},
"whTaskName": {
"type": "string",
"nullable": true,
"description": "付帯作業名"
},
"packingID": {
"type": "string",
"nullable": true,
"description": "梱包ID"
},
"dateShippingDeadline": {
"type": "string",
"nullable": true,
"description": "出荷期限日"
},
"qualityOrigin": {
"type": "string",
"nullable": true,
"description": "予定格付け区分"
},
"quality": {
"type": "string",
"nullable": true,
"description": "実績格付け区分"
},
"qualityReason": {
"type": "string",
"nullable": true,
"description": "格付け理由"
},
"headText10": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目1"
},
"headText11": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目2"
},
"headText12": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目3"
},
"headText13": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目4"
}
},
"required": [
"itemPONo",
"poTypeCode",
"poTypeName",
"poStateCode",
"poStateName",
"itemNo",
"itemName",
"poNo",
"lotNo",
"qtyPO",
"qtyPOOrigin",
"datePOEntry",
"dateDelivPromise",
"dateDelivFinish",
"dateExpiration",
"supplierCode",
"supplierName",
"supplierNameS",
"siteCode",
"siteName",
"shippingPointCode",
"shippingPointName",
"arrivalTransporterTypeCode",
"arrivalTransporterTypeName",
"arrivalTransInvNo",
"whTaskCode",
"whTaskName",
"packingID",
"dateShippingDeadline"
],
"type": "object",
"additionalProperties": false
},
"ExtGetItemPOArrivalDto": {
"properties": {
"itemPONo": {
"type": "string",
"description": "発注番号",
"maxLength": 7
},
"itemNo": {
"type": "string",
"description": "商品コード",
"maxLength": 100
},
"supplierCode": {
"type": "string",
"description": "仕入先コード",
"maxLength": 20
},
"dateDelivFinishFrom": {
"type": "string",
"description": "入荷実績日（開始）yyyy-MM-dd形式",
"maxLength": 10
},
"dateDelivFinishTo": {
"type": "string",
"description": "入荷実績日（終了）yyyy-MM-dd形式",
"maxLength": 10
},
"arrivalTransInvNo": {
"type": "string",
"description": "入荷伝票番号",
"maxLength": 300
},
"poNo": {
"type": "string",
"description": "発注番号",
"maxLength": 20
},
"packingID": {
"type": "string",
"description": "梱包ID",
"maxLength": 7
},
"page": {
"type": "integer",
"format": "int32",
"description": "page",
"default": 1
},
"limit": {
"type": "integer",
"format": "int32",
"description": "limit",
"default": 5000
}
},
"type": "object",
"additionalProperties": false
},
"PoStateCodeValue": {
"anyOf": [
{
"$ref": "#/components/schemas/PlanPoStateCodeValue"
},
{
"$ref": "#/components/schemas/ArrivalPoStateCodeValue"
}
],
"description": "発注ステータスコード\n130：入荷待ち\n150：荷受済み\n155：格納待ち\n200：入荷済み"
},
"ExtItemPOResponseDto": {
"properties": {
"itemPONo": {
"type": "string",
"description": "入荷ID"
},
"poTypeCode": {
"$ref": "#/components/schemas/POTypeCodeValue"
},
"poTypeName": {
"type": "string",
"description": "発注区分名"
},
"poStateCode": {
"$ref": "#/components/schemas/PoStateCodeValue",
"description": "発注ステータスコード（ジェネリクスで動的に変えられる）"
},
"poStateName": {
"type": "string",
"description": "発注ステータス名"
},
"itemNo": {
"type": "string",
"description": "商品コード"
},
"itemName": {
"type": "string",
"description": "商品名"
},
"poNo": {
"type": "string",
"nullable": true,
"description": "発注番号"
},
"lotNo": {
"type": "string",
"nullable": true,
"description": "ロット番号"
},
"qtyPO": {
"type": "integer",
"format": "int32",
"description": "入荷実績数量"
},
"qtyPOOrigin": {
"type": "integer",
"format": "int32",
"description": "入荷予定数量"
},
"datePOEntry": {
"type": "string",
"nullable": true,
"description": "発注登録日"
},
"dateDelivPromise": {
"type": "string",
"description": "入荷予定日"
},
"dateDelivFinish": {
"type": "string",
"description": "入荷実績日"
},
"dateExpiration": {
"type": "string",
"nullable": true,
"description": "有効期限"
},
"supplierCode": {
"type": "string",
"description": "仕入先コード"
},
"supplierName": {
"type": "string",
"description": "仕入先名"
},
"supplierNameS": {
"type": "string",
"nullable": true,
"description": "仕入先略称"
},
"siteCode": {
"type": "string",
"nullable": true,
"description": "倉庫コード"
},
"siteName": {
"type": "string",
"nullable": true,
"description": "倉庫名"
},
"shippingPointCode": {
"allOf": [
{
"$ref": "#/components/schemas/ShippingPointCodeValue"
}
],
"nullable": true
},
"shippingPointName": {
"type": "string",
"nullable": true,
"description": "出荷場所名"
},
"arrivalTransporterTypeCode": {
"type": "string",
"nullable": true,
"description": "入荷運送会社コード"
},
"arrivalTransporterTypeName": {
"type": "string",
"nullable": true,
"description": "入荷運送会社名"
},
"arrivalTransInvNo": {
"type": "string",
"nullable": true,
"description": "入荷伝票番号"
},
"whTaskCode": {
"type": "string",
"nullable": true,
"description": "付帯作業コード(複数ある場合カンマ区切り)"
},
"whTaskName": {
"type": "string",
"nullable": true,
"description": "付帯作業名"
},
"packingID": {
"type": "string",
"nullable": true,
"description": "梱包ID"
},
"dateShippingDeadline": {
"type": "string",
"nullable": true,
"description": "出荷期限日"
},
"qualityOrigin": {
"type": "string",
"nullable": true,
"description": "予定格付け区分"
},
"quality": {
"type": "string",
"nullable": true,
"description": "実績格付け区分"
},
"qualityReason": {
"type": "string",
"nullable": true,
"description": "格付け理由"
},
"headText10": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目1"
},
"headText11": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目2"
},
"headText12": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目3"
},
"headText13": {
"type": "string",
"nullable": true,
"description": "入荷フリー項目4"
}
},
"required": [
"itemPONo",
"poTypeCode",
"poTypeName",
"poStateCode",
"poStateName",
"itemNo",
"itemName",
"poNo",
"lotNo",
"qtyPO",
"qtyPOOrigin",
"datePOEntry",
"dateDelivPromise",
"dateDelivFinish",
"dateExpiration",
"supplierCode",
"supplierName",
"supplierNameS",
"siteCode",
"siteName",
"shippingPointCode",
"shippingPointName",
"arrivalTransporterTypeCode",
"arrivalTransporterTypeName",
"arrivalTransInvNo",
"whTaskCode",
"whTaskName",
"packingID",
"dateShippingDeadline"
],
"type": "object",
"additionalProperties": false
},
"ApiErrorResponse": {
"properties": {
"message": {
"type": "string"
},
"errors": {}
},
"required": [
"message"
],
"type": "object",
"additionalProperties": false
},
"ArrivalTransporterTypeCodeValue": {
"type": "string",
"enum": [
"100",
"101",
"200",
"201",
"900"
],
"description": "【入荷運送会社コード】
\n100：トラック(路線便)
\n101：トラック(チャーター)
\n200：コンテナ(20ft)
\n201：コンテナ(40ft)
\n900：その他
"
},
"ExtCreateItemPODto": {
"properties": {
"itemNo": {
"type": "string",
"description": "商品コード",
"maxLength": 100
},
"wHTaskList": {
"type": "string",
"description": "【入荷時の付帯作業】
\n1000:混載仕分け
\n1010:バーコード貼り付け
\n1020:員数
\n1030:プチ巻き
\n1040:プチ2重巻き
\n1060:チラシ印刷
\n1070:袋入れ
\n1080:賞味期限確認
\n1090:立替
\n1100:BtoB返品
\n1110:特殊付帯
\n複数指定する場合は、コード値をカンマ区切りで連結して指定してください（例: 1000,1010）。
"
},
"poNo": {
"type": "string",
"description": "発注番号",
"maxLength": 20
},
"lotNo": {
"type": "string",
"description": "ロット番号",
"maxLength": 20
},
"supplierCode": {
"type": "string",
"description": "仕入先コード",
"maxLength": 20
},
"unitPurchasePrice": {
"type": "integer",
"format": "int32",
"description": "仕入単価"
},
"qtyPO": {
"type": "integer",
"format": "int32",
"description": "発注数量"
},
"datePOEntry": {
"type": "string",
"description": "登録日",
"maxLength": 10
},
"dateDelivPromise": {
"type": "string",
"description": "入荷予定日",
"maxLength": 10
},
"dateExpiration": {
"type": "string",
"description": "消費期限",
"maxLength": 10
},
"dateShippingDeadline": {
"type": "string",
"description": "出荷期限日",
"maxLength": 10
},
"arrivalTransporterTypeCode": {
"$ref": "#/components/schemas/ArrivalTransporterTypeCodeValue"
},
"arrivalTransInvNo": {
"type": "string",
"description": "入荷伝票番号",
"maxLength": 300
},
"headText10": {
"type": "string",
"description": "入荷フリー項目1",
"maxLength": 200
},
"headText11": {
"type": "string",
"description": "入荷フリー項目2",
"maxLength": 200
},
"headText12": {
"type": "string",
"description": "入荷フリー項目3",
"maxLength": 200
},
"headText13": {
"type": "string",
"description": "入荷フリー項目4",
"maxLength": 200
},
"headText14": {
"type": "string",
"description": "入荷フリー項目5",
"maxLength": 200
},
"qualityOrigin": {
"type": "string",
"nullable": true,
"description": "指示格付け区分"
}
},
"required": [
"itemNo",
"qtyPO",
"dateDelivPromise",
"arrivalTransporterTypeCode"
],
"type": "object",
"additionalProperties": false
},
"ExtCreateItemPOPackingBulkItemResponseDto": {
"properties": {
"lineNo": {
"type": "integer",
"format": "int32",
"description": "request 側の箱内明細番号"
},
"itemPONo": {
"type": "string",
"description": "作成された入荷ID"
},
"itemNo": {
"type": "string",
"description": "商品コード"
},
"qtyPO": {
"type": "integer",
"format": "int32",
"description": "登録数量"
},
"poStateCode": {
"$ref": "#/components/schemas/PoStateCodeValue",
"description": "入荷ステータスコード"
},
"poStateName": {
"type": "string",
"description": "入荷ステータス名"
}
},
"required": [
"lineNo",
"itemPONo",
"itemNo",
"qtyPO",
"poStateCode",
"poStateName"
],
"type": "object",
"additionalProperties": false
},
"ExtCreateItemPOPackingBulkBoxResponseDto": {
"properties": {
"boxNo": {
"type": "integer",
"format": "int32",
"description": "request 側の箱識別番号"
},
"packingID": {
"type": "string",
"description": "梱包ID"
},
"pkgBarcode": {
"type": "string",
"description": "外装ラベル用バーコード文字列"
},
"itemPOs": {
"items": {
"$ref": "#/components/schemas/ExtCreateItemPOPackingBulkItemResponseDto"
},
"type": "array",
"description": "箱配下の作成結果"
}
},
"required": [
"boxNo",
"packingID",
"pkgBarcode",
"itemPOs"
],
"type": "object",
"additionalProperties": false
},
"ExtCreateItemPOPackingBulkResponseDto": {
"properties": {
"datePOEntry": {
"type": "string",
"nullable": true,
"description": "登録日"
},
"dateDelivPromise": {
"type": "string",
"description": "入荷予定日"
},
"arrivalTransporterTypeCode": {
"type": "string",
"description": "入荷運送会社コード"
},
"arrivalTransporterTypeName": {
"type": "string",
"description": "入荷運送会社名"
},
"arrivalTransInvNo": {
"type": "string",
"nullable": true,
"description": "入荷伝票番号"
},
"boxes": {
"items": {
"$ref": "#/components/schemas/ExtCreateItemPOPackingBulkBoxResponseDto"
},
"type": "array",
"description": "箱ごとの作成結果"
}
},
"required": [
"datePOEntry",
"dateDelivPromise",
"arrivalTransporterTypeCode",
"arrivalTransporterTypeName",
"arrivalTransInvNo",
"boxes"
],
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSA_ItemPOCreate_ForAPI": {
"properties": {
"message": {
"type": "string",
"enum": [
"会社コードは必須です。",
"商品コードは必須です。",
"入荷予定日は必須です。",
"輸送種別コードは必須です。",
"入荷予定数は必須です。",
"入荷予定日に、当日および過去の日付は指定出来ません。",
"消費期限に、当日および過去の日付は指定出来ません。",
"出荷期限に、当日および過去の日付は指定出来ません。",
"登録日に未来の日付は登録できません。",
"指定された輸送種別コードは存在しません。",
"指定された仕入先コードは存在しません。",
"入荷予定数は1以上で登録してください。",
"指定された品番はマスターに存在しません。",
"指定された商品は過去に出荷期限(消費期限)が設定されています。出荷期限(消費期限)の設定が必要です。",
"セット商品は登録出来ません。構成商品で登録ください。",
"ロット管理商品はロットNoの入力が必須です。",
"指定された付帯作業コードはマスターに存在しません。"
]
}
},
"required": [
"message"
],
"type": "object"
},
"ExtCreateItemPOPackingBulkItemDto": {
"properties": {
"lineNo": {
"type": "integer",
"format": "int32",
"description": "箱内明細番号"
},
"itemNo": {
"type": "string",
"description": "商品コード",
"maxLength": 100
},
"wHTaskList": {
"type": "string",
"description": "【入荷時の付帯作業】
\n1000:混載仕分け
\n1010:バーコード貼り付け
\n1020:員数
\n1030:プチ巻き
\n1040:プチ2重巻き
\n1060:チラシ印刷
\n1070:袋入れ
\n1080:賞味期限確認
\n1090:立替
\n1100:BtoB返品
\n1110:特殊付帯
\n複数指定する場合は、コード値をカンマ区切りで連結して指定してください（例: 1000,1010）。
"
},
"poNo": {
"type": "string",
"description": "発注番号",
"maxLength": 20
},
"lotNo": {
"type": "string",
"description": "ロット番号",
"maxLength": 20
},
"supplierCode": {
"type": "string",
"description": "仕入先コード",
"maxLength": 20
},
"unitPurchasePrice": {
"type": "integer",
"format": "int32",
"description": "仕入単価"
},
"qtyPO": {
"type": "integer",
"format": "int32",
"description": "発注数量"
},
"dateExpiration": {
"type": "string",
"description": "消費期限",
"maxLength": 10
},
"dateShippingDeadline": {
"type": "string",
"description": "出荷期限日",
"maxLength": 10
},
"headText10": {
"type": "string",
"description": "入荷フリー項目1",
"maxLength": 200
},
"headText11": {
"type": "string",
"description": "入荷フリー項目2",
"maxLength": 200
},
"headText12": {
"type": "string",
"description": "入荷フリー項目3",
"maxLength": 200
},
"headText13": {
"type": "string",
"description": "入荷フリー項目4",
"maxLength": 200
},
"headText14": {
"type": "string",
"description": "入荷フリー項目5",
"maxLength": 200
},
"qualityOrigin": {
"type": "string",
"nullable": true,
"description": "指示格付け区分"
}
},
"required": [
"lineNo",
"itemNo",
"qtyPO"
],
"type": "object",
"additionalProperties": false
},
"ExtCreateItemPOPackingBulkBoxDto": {
"properties": {
"boxNo": {
"type": "integer",
"format": "int32",
"description": "request 内の箱識別番号"
},
"items": {
"items": {
"$ref": "#/components/schemas/ExtCreateItemPOPackingBulkItemDto"
},
"type": "array",
"description": "箱内明細一覧"
}
},
"required": [
"boxNo",
"items"
],
"type": "object",
"additionalProperties": false
},
"ExtCreateItemPOPackingBulkDto": {
"properties": {
"datePOEntry": {
"type": "string",
"description": "登録日",
"maxLength": 10
},
"dateDelivPromise": {
"type": "string",
"description": "入荷予定日",
"maxLength": 10
},
"arrivalTransporterTypeCode": {
"$ref": "#/components/schemas/ArrivalTransporterTypeCodeValue",
"description": "入荷運送会社コード"
},
"arrivalTransInvNo": {
"type": "string",
"description": "入荷伝票番号",
"maxLength": 300
},
"boxes": {
"items": {
"$ref": "#/components/schemas/ExtCreateItemPOPackingBulkBoxDto"
},
"type": "array",
"description": "箱一覧"
}
},
"required": [
"dateDelivPromise",
"arrivalTransporterTypeCode",
"boxes"
],
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSA_ItemPOUpdate_ForAPI": {
"properties": {
"message": {
"type": "string",
"enum": [
"会社コードは必須です。",
"商品発注番号は必須です。",
"最新更新日時は必須です。",
"入荷予定日は必須です。",
"仕入先コードは必須です。",
"輸送種別コードは必須です。",
"入荷予定数は必須です。",
"入荷予定日に、当日および過去の日付は指定出来ません。",
"消費期限に、当日および過去の日付は指定出来ません。",
"出荷期限に、当日および過去の日付は指定出来ません。",
"指定された輸送種別コードは存在しません。",
"指定された仕入先コードは存在しません。",
"入荷予定数は1以上で登録してください。",
"指定された商品は過去に出荷期限(消費期限)が設定されています。出荷期限(消費期限)の設定が必要です。",
"更新できない入荷ステータスのデータです。",
"ロット管理商品はロットNoの入力が必須です。",
"指定された付帯作業コードはマスターに存在しません。"
]
}
},
"required": [
"message"
],
"type": "object"
},
"ExtUpdateItemPODto": {
"properties": {
"wHTaskList": {
"type": "string",
"description": "【入荷時の付帯作業】
\n1000:混載仕分け
\n1010:バーコード貼り付け
\n1020:員数
\n1030:プチ巻き
\n1040:プチ2重巻き
\n1060:チラシ印刷
\n1070:袋入れ
\n1080:賞味期限確認
\n1090:立替
\n1100:BtoB返品
\n1110:特殊付帯
\n複数指定する場合は、コード値をカンマ区切りで連結して指定してください（例: 1000,1010）。
"
},
"poNo": {
"type": "string",
"description": "発注番号",
"maxLength": 20
},
"lotNo": {
"type": "string",
"description": "ロット番号",
"maxLength": 20
},
"supplierCode": {
"type": "string",
"description": "仕入先コード",
"maxLength": 20
},
"unitPurchasePrice": {
"type": "integer",
"format": "int32",
"description": "仕入単価"
},
"qtyPO": {
"type": "integer",
"format": "int32",
"description": "発注数量"
},
"dateDelivPromise": {
"type": "string",
"description": "入荷予定日",
"maxLength": 10
},
"dateExpiration": {
"type": "string",
"description": "消費期限",
"maxLength": 10
},
"dateShippingDeadline": {
"type": "string",
"description": "出荷期限日",
"maxLength": 10
},
"arrivalTransporterTypeCode": {
"$ref": "#/components/schemas/ArrivalTransporterTypeCodeValue"
},
"arrivalTransInvNo": {
"type": "string",
"description": "入荷伝票番号",
"maxLength": 300
},
"headText10": {
"type": "string",
"description": "入荷フリー項目1",
"maxLength": 200
},
"headText11": {
"type": "string",
"description": "入荷フリー項目2",
"maxLength": 200
},
"headText12": {
"type": "string",
"description": "入荷フリー項目3",
"maxLength": 200
},
"headText13": {
"type": "string",
"description": "入荷フリー項目4",
"maxLength": 200
},
"headText14": {
"type": "string",
"description": "入荷フリー項目5",
"maxLength": 200
},
"qualityOrigin": {
"type": "string",
"nullable": true,
"description": "指示格付け区分"
}
},
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSA_ItemPOCancel_ForAPI": {
"properties": {
"message": {
"type": "string",
"enum": [
"処理できません。 該当データは存在しません。",
"処理できません。 更新できない入荷ステータスです。"
]
}
},
"required": [
"message"
],
"type": "object"
},
"ExtReleaseItemPOPackingResponseDto": {
"properties": {
"packingID": {
"type": "string",
"description": "解除対象の梱包ID"
},
"released": {
"type": "boolean",
"description": "解除成功フラグ"
},
"itemPONos": {
"items": {
"type": "string"
},
"type": "array",
"description": "解除対象の入荷ID一覧"
}
},
"required": [
"packingID",
"released",
"itemPONos"
],
"type": "object",
"additionalProperties": false
},
"ECOrderDetailResponse": {
"properties": {
"ecItemNo": {
"type": "string",
"nullable": true,
"description": "商品コード"
},
"ecItemName": {
"type": "string",
"nullable": true,
"description": "商品名"
},
"unitPrice": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "単価"
},
"qtyOrder": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "受注数量"
}
},
"required": [
"ecItemNo",
"ecItemName",
"unitPrice",
"qtyOrder"
],
"type": "object",
"additionalProperties": false
},
"ExtECOrderResponseDto": {
"properties": {
"custShopCode": {
"type": "string",
"description": "店舗コード"
},
"orderNo": {
"type": "string",
"description": "注文番号"
},
"mallOrderNo": {
"type": "string",
"nullable": true,
"description": "モールID"
},
"dateOrder": {
"type": "string",
"description": "受注日"
},
"datePayment": {
"type": "string",
"nullable": true,
"description": "支払日"
},
"dateShip": {
"type": "string",
"nullable": true,
"description": "出荷日"
},
"orderName": {
"type": "string",
"description": "購入者の名前"
},
"orderNameKana": {
"type": "string",
"nullable": true,
"description": "購入者の名前（カナ）"
},
"orderZipCode": {
"type": "string",
"description": "購入者の郵便番号"
},
"orderPrefName": {
"type": "string",
"description": "購入者の都道府県"
},
"orderAddress1": {
"type": "string",
"description": "購入者の住所1"
},
"orderAddress2": {
"type": "string",
"description": "購入者の住所2"
},
"orderAddress3": {
"type": "string",
"nullable": true,
"description": "購入者の住所3"
},
"orderAddress4": {
"type": "string",
"nullable": true,
"description": "購入者の住所4"
},
"orderPhone": {
"type": "string",
"nullable": true,
"description": "購入者の電話番号"
},
"orderFax": {
"type": "string",
"nullable": true,
"description": "購入者のFAX番号"
},
"orderEMail": {
"type": "string",
"description": "購入者のメールアドレス"
},
"shippingName": {
"type": "string",
"description": "お届け先の名前"
},
"shippingNameKana": {
"type": "string",
"nullable": true,
"description": "お届け先の名前（カナ）"
},
"shippingZipCode": {
"type": "string",
"description": "お届け先の郵便番号"
},
"shippingPrefName": {
"type": "string",
"description": "お届け先の都道府県"
},
"shippingAddress1": {
"type": "string",
"description": "お届け先の住所1"
},
"shippingAddress2": {
"type": "string",
"description": "お届け先の住所2"
},
"shippingAddress3": {
"type": "string",
"nullable": true,
"description": "お届け先の住所3"
},
"shippingAddress4": {
"type": "string",
"nullable": true,
"description": "お届け先の住所4"
},
"shippingPhone": {
"type": "string",
"description": "お届け先の電話番号"
},
"shippingFax": {
"type": "string",
"nullable": true,
"description": "お届け先のFAX番号"
},
"transInvNo": {
"type": "string",
"description": "伝票番号"
},
"dateDesiredDelivery": {
"type": "string",
"nullable": true,
"description": "希望配送日"
},
"desiredDeliveryName": {
"type": "string",
"description": "希望お届け希望時間帯"
},
"desiredDeliveryTime": {
"type": "string",
"nullable": true,
"description": "希望配送時間帯"
},
"qtyTotal": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "合計数量"
},
"amtPurchaseTotal": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "購入金額合計"
},
"amtDiscount": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "値引き額"
},
"amtDiscount_Etc1": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "その他値引き額1"
},
"amtDiscount_Etc2": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "その他値引き額2"
},
"taxCost": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "消費税"
},
"amtShippingCharge": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "送料"
},
"amtDaibikiCharge": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "代引き手数料"
},
"amtWrappingCharge": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "包装手数料"
},
"amtSundryCharge": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "その他手数料"
},
"amtSundryCharge_Etc1": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "その他雑費1"
},
"amtSundryCharge_Etc2": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "その他雑費2"
},
"amtTotal": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "合計金額"
},
"amtPointUsing": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "ポイント利用"
},
"amtCouponUsing": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "クーポン利用"
},
"amtPaymentTotal": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "お支払い総合計"
},
"giftFlag": {
"type": "boolean",
"description": "ギフトフラグ"
},
"socialGiftFlag": {
"type": "boolean",
"description": "ソーシャルギフトフラグ\n\nONの場合、納品書・送り状の注文者（購入者）情報をマスクし、領収書を発行しません。"
},
"wrapping": {
"type": "string",
"nullable": true,
"description": "包装指定"
},
"noshi": {
"type": "string",
"nullable": true,
"description": "熨斗（のし）指定"
},
"orderMemo": {
"type": "string",
"description": "受注メモ"
},
"orderShopMemo": {
"type": "string",
"nullable": true,
"description": "受注店舗メモ"
},
"custShopName": {
"type": "string",
"description": "店舗名"
},
"orderStateName": {
"type": "string",
"nullable": true,
"description": "受注ステータス名"
},
"transporterCode": {
"type": "string",
"nullable": true,
"description": "配送方法コード"
},
"transporterName": {
"type": "string",
"nullable": true,
"description": "配送方法名"
},
"deliveryHandoverLocationCode": {
"type": "string",
"nullable": true,
"description": "【配送指定場所コード】指定がない場合はnullを返却します。
\n10：対面
\n11：玄関前
\n12：宅配ボックス
\n13：ガスメーターボックス
\n14：物置
\n15：車庫
\n16：自転車かご
\n17：建物内受付／管理人預け
\n【対象配送方法】
\n9001：おまかせ便(ソフト)
\n9002：おまかせ便(ハード)
\n9003：おまかせ便(ケース出荷)
\n1010：ヤマト運輸 宅急便EAZY(ソフト)
\n1011：ヤマト運輸 宅急便EAZY(ハード)
\n2001：佐川急便 飛脚宅配便"
},
"deliveryHandoverLocationName": {
"type": "string",
"nullable": true,
"description": "配送指定場所名。指定がない場合はnullを返却します。"
},
"shippingPointName": {
"type": "string",
"nullable": true,
"description": "出荷場所名"
},
"paymentMethod": {
"type": "string",
"nullable": true,
"description": "変換前支払方法名"
},
"paymentMethodName": {
"type": "string",
"nullable": true,
"description": "変換後支払方法名"
},
"deliveryTimeName": {
"type": "string",
"nullable": true,
"description": "お届け希望時間帯"
},
"siteName": {
"type": "string",
"nullable": true,
"description": "倉庫名"
},
"shipId": {
"type": "string",
"nullable": true,
"description": "出荷管理番号"
},
"orderCompanyName": {
"type": "string",
"nullable": true,
"description": "購入者会社名"
},
"orderCountryName": {
"type": "string",
"nullable": true,
"description": "購入者国名"
},
"shippingCompanyName": {
"type": "string",
"nullable": true,
"description": "お届け先会社名"
},
"shippingCountryName": {
"type": "string",
"nullable": true,
"description": "お届け先国名"
},
"paymentMethodCode": {
"type": "string",
"nullable": true,
"description": "支払方法コード"
},
"shippingTagDescription": {
"type": "string",
"nullable": true,
"description": "送り状特記事項"
},
"deliveryTimeCode": {
"type": "string",
"nullable": true,
"description": "配送時間コード"
},
"waitForConfirmFlag": {
"type": "boolean",
"nullable": true,
"description": "保留フラグ"
},
"waitForConfirmReason": {
"type": "string",
"nullable": true,
"description": "保留理由"
},
"headText10": {
"type": "string",
"nullable": true,
"description": "受注フリー項目1"
},
"headText11": {
"type": "string",
"nullable": true,
"description": "受注フリー項目2"
},
"headText12": {
"type": "string",
"nullable": true,
"description": "受注フリー項目3"
},
"headText13": {
"type": "string",
"nullable": true,
"description": "受注フリー項目4"
},
"headText14": {
"type": "string",
"nullable": true,
"description": "受注フリー項目5"
},
"cntPurchased": {
"type": "number",
"format": "double",
"nullable": true,
"description": "購入回数"
},
"cntSubscription": {
"type": "number",
"format": "double",
"nullable": true,
"description": "定期購入回数"
},
"receiptFlag": {
"type": "boolean",
"nullable": true,
"description": "領収書フラグ"
},
"receiptName": {
"type": "string",
"nullable": true,
"description": "領収書名"
},
"honorific": {
"type": "string",
"nullable": true,
"description": "敬称"
},
"receiptDescription": {
"type": "string",
"nullable": true,
"description": "領収書説明"
},
"amtReceipt": {
"type": "number",
"format": "double",
"nullable": true,
"description": "領収書金額"
},
"dateReceipt": {
"type": "string",
"nullable": true,
"description": "領収書日付"
},
"orderOptionNo": {
"type": "string",
"nullable": true,
"description": "特殊梱包番号"
},
"orderErrorFlags": {
"type": "number",
"format": "double",
"nullable": true,
"description": "受注エラー種別"
},
"lineMemo": {
"type": "string",
"nullable": true,
"description": "受注明細備考"
},
"dateCredit": {
"type": "string",
"nullable": true,
"description": "取引日付"
},
"volumePackingSplitFlag": {
"type": "boolean",
"nullable": true,
"description": "体積上限による個口分割フラグ"
},
"shippingTypeCode": {
"type": "string",
"nullable": true,
"description": "出荷区分コード"
},
"ecOrderDtl": {
"items": {
"$ref": "#/components/schemas/ECOrderDetailResponse"
},
"type": "array"
}
},
"required": [
"custShopCode",
"orderNo",
"mallOrderNo",
"dateOrder",
"datePayment",
"dateShip",
"orderName",
"orderNameKana",
"orderZipCode",
"orderPrefName",
"orderAddress1",
"orderAddress2",
"orderAddress3",
"orderAddress4",
"orderPhone",
"orderFax",
"orderEMail",
"shippingName",
"shippingNameKana",
"shippingZipCode",
"shippingPrefName",
"shippingAddress1",
"shippingAddress2",
"shippingAddress3",
"shippingAddress4",
"shippingPhone",
"shippingFax",
"transInvNo",
"dateDesiredDelivery",
"desiredDeliveryName",
"desiredDeliveryTime",
"qtyTotal",
"amtPurchaseTotal",
"amtDiscount",
"amtDiscount_Etc1",
"amtDiscount_Etc2",
"taxCost",
"amtShippingCharge",
"amtDaibikiCharge",
"amtWrappingCharge",
"amtSundryCharge",
"amtSundryCharge_Etc1",
"amtSundryCharge_Etc2",
"amtTotal",
"amtPointUsing",
"amtCouponUsing",
"amtPaymentTotal",
"giftFlag",
"socialGiftFlag",
"wrapping",
"noshi",
"orderMemo",
"orderShopMemo",
"custShopName",
"orderStateName",
"transporterCode",
"transporterName",
"deliveryHandoverLocationCode",
"deliveryHandoverLocationName",
"shippingPointName",
"paymentMethod",
"paymentMethodName",
"deliveryTimeName",
"siteName",
"shipId",
"orderCompanyName",
"orderCountryName",
"shippingCompanyName",
"shippingCountryName",
"paymentMethodCode",
"shippingTagDescription",
"deliveryTimeCode",
"waitForConfirmFlag",
"waitForConfirmReason",
"headText10",
"headText11",
"headText12",
"headText13",
"headText14",
"cntPurchased",
"cntSubscription",
"receiptFlag",
"receiptName",
"honorific",
"receiptDescription",
"amtReceipt",
"dateReceipt",
"orderOptionNo",
"orderErrorFlags",
"lineMemo",
"dateCredit",
"ecOrderDtl"
],
"type": "object",
"additionalProperties": false
},
"OrderTypeCodeValue": {
"type": "string",
"enum": [
"120",
"121"
],
"description": "【受注種別コード】
\n120: 受注
\n121: 出荷指示
"
},
"OrderTransporterCodeValue": {
"type": "string",
"enum": [
"9001",
"9002",
"9003",
"1009",
"1001",
"1010",
"1011",
"1002",
"1004",
"2001",
"5013"
],
"description": "【配送方法コード】
\n9001：おまかせ便(ソフト)
\n9002：おまかせ便(ハード)
\n9003：おまかせ便(ケース出荷)
\n1009：ヤマト運輸 宅急便(ソフト)
\n1001：ヤマト運輸 宅急便(ハード)
\n1010：ヤマト運輸 宅急便EAZY(ソフト)
\n1011：ヤマト運輸 宅急便EAZY(ハード)
\n1002：ヤマト運輸 宅急便コンパクト
\n1004：ヤマト運輸 ネコポス
\n2001：佐川急便 飛脚宅配便
\n5013：DHLエクスプレスサービス
"
},
"ForeignTransporterCodeValue": {
"type": "string",
"enum": [
"1210"
],
"nullable": false,
"description": "【海外向け配送方法コード】
\n1210：ヤマト運輸 国際宅急便(海外用)
"
},
"ShipTransporterCodeValue": {
"type": "string",
"enum": [
"9002",
"4001",
"5016",
"5017",
"5018",
"5019",
"5020",
"5021",
"5022",
"5023"
],
"description": "【出荷指示】
\n9002：おまかせ便(ハード)
\n4001：グリーンボックス
\n5016：(その他)店頭受取
\n5017：(その他)メーカー直送
\n5018：(その他)チャーター便
\n5019：(その他)倉庫内移動
\n5020：(その他)倉庫受取
\n5021：(その他)流通加工指示
\n5022：(その他)廃棄
\n5023：(その他)FBA専用ヤマト運輸
"
},
"TransporterCodeValue": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderTransporterCodeValue"
},
{
"$ref": "#/components/schemas/ForeignTransporterCodeValue"
},
{
"$ref": "#/components/schemas/ShipTransporterCodeValue"
}
],
"description": "【受注】
\n9001：おまかせ便(ソフト)
\n9002：おまかせ便(ハード)
\n9003：おまかせ便(ケース出荷)
\n1009：ヤマト運輸 宅急便(ソフト)
\n1001：ヤマト運輸 宅急便(ハード)
\n1010：ヤマト運輸 宅急便EAZY(ソフト)
\n1011：ヤマト運輸 宅急便EAZY(ハード)
\n1002：ヤマト運輸 宅急便コンパクト
\n1004：ヤマト運輸 ネコポス
\n1210：ヤマト運輸 国際宅急便(海外用)
\n2001：佐川急便 飛脚宅配便
\n5013：DHLエクスプレスサービス
\n\n【出荷指示】
\n9002：おまかせ便(ハード)
\n4001：グリーンボックス
\n5016：(その他)店頭受取
\n5017：(その他)メーカー直送
\n5018：(その他)チャーター便
\n5019：(その他)倉庫内移動
\n5020：(その他)倉庫受取
\n5021：(その他)流通加工指示
\n5022：(その他)廃棄
\n5023：(その他)FBA専用ヤマト運輸
"
},
"PaymentMethodCodeValue": {
"type": "string",
"enum": [
"1000",
"1001",
"1002",
"1003",
"1004",
"1005",
"1006",
"1007",
"1008",
"1009",
"1010",
"1011",
"1012",
"1013",
"1014",
"1015"
],
"description": "【支払方法コード】
\n1000:クレジットカード決済
\n1001：代金引換
\n1002：銀行振込
\n1003：コンビニ決済
\n1004：後払い決済
\n1005：現金払い
\n1006：ペイジー
\n1007：Paypal
\n1008：支払なし
\n1009：キャリア決済
\n1010：電子マネー決済
\n1011：郵便振替
\n1012：現金書留
\n1013：掛売
\n1014：プラットフォーム決済
\n1015：NP後払い
"
},
"ExtGetECOrderPlanDto": {
"properties": {
"orderNo": {
"type": "string",
"description": "受注番号"
},
"mallOrderNo": {
"type": "string",
"description": "モール受注番号"
},
"orderTypeCode": {
"$ref": "#/components/schemas/OrderTypeCodeValue"
},
"orderStateCode": {
"type": "string",
"description": "【受注ステータスコード（カンマ区切りの複数指定）】
\n100：確認待ち
\n120：入金待ち
\n130：同梱待ち
\n150：引き当て待ち
\n300：出荷待ち
\n400：出荷作業中
"
},
"transporterCode": {
"$ref": "#/components/schemas/TransporterCodeValue"
},
"paymentMethodCode": {
"$ref": "#/components/schemas/PaymentMethodCodeValue"
},
"shippingName": {
"type": "string",
"description": "お届け先名"
},
"custShopCode": {
"type": "string",
"description": "店舗コード"
},
"dateOrderFrom": {
"type": "string",
"description": "受注日From"
},
"dateOrderTo": {
"type": "string",
"description": "受注日To"
},
"waitForConfirmFlag": {
"type": "boolean",
"description": "出荷保留フラグ"
},
"ecItemNo": {
"type": "string",
"description": "商品コード"
},
"shipId": {
"type": "string",
"description": "出荷管理番号"
},
"isOrderError": {
"type": "boolean",
"description": "住所エラーデータのみ表示"
}
},
"type": "object",
"additionalProperties": false
},
"ExtGetECOrderResultDto": {
"properties": {
"orderNo": {
"type": "string",
"description": "受注番号"
},
"mallOrderNo": {
"type": "string",
"description": "モール受注番号"
},
"orderTypeCode": {
"$ref": "#/components/schemas/OrderTypeCodeValue"
},
"transporterCode": {
"$ref": "#/components/schemas/TransporterCodeValue"
},
"paymentMethodCode": {
"$ref": "#/components/schemas/PaymentMethodCodeValue"
},
"shippingName": {
"type": "string",
"description": "お届け先名"
},
"custShopCode": {
"type": "string",
"description": "店舗コード"
},
"dateOrderFrom": {
"type": "string",
"description": "受注日From"
},
"dateOrderTo": {
"type": "string",
"description": "受注日To"
},
"dateShipFrom": {
"type": "string",
"description": "出荷日From"
},
"dateShipTo": {
"type": "string",
"description": "出荷日To"
},
"waitForConfirmFlag": {
"type": "boolean",
"description": "出荷保留フラグ"
},
"ecItemNo": {
"type": "string",
"description": "商品コード"
},
"shipId": {
"type": "string",
"description": "出荷管理番号"
},
"isOrderError": {
"type": "boolean",
"description": "住所エラーデータのみ表示"
}
},
"type": "object",
"additionalProperties": false
},
"ExtECOrderPackingDimensionSource": {
"type": "string",
"enum": [
"CARTON_SIZE_MASTER",
"HANDY_INSPECTION"
]
},
"ExtECOrderPackingCartonDimensionsDto": {
"properties": {
"width": {
"type": "number",
"format": "double",
"description": "幅"
},
"depth": {
"type": "number",
"format": "double",
"description": "奥行"
},
"height": {
"type": "number",
"format": "double",
"description": "高さ"
},
"unit": {
"type": "string",
"enum": [
"m"
],
"nullable": false,
"description": "単位"
},
"source": {
"$ref": "#/components/schemas/ExtECOrderPackingDimensionSource",
"description": "取得元"
}
},
"required": [
"width",
"depth",
"height",
"unit",
"source"
],
"type": "object",
"additionalProperties": false
},
"ExtECOrderPackingWeightDto": {
"properties": {
"value": {
"type": "number",
"format": "double",
"description": "重量"
},
"unit": {
"type": "string",
"enum": [
"kg"
],
"nullable": false,
"description": "単位"
},
"source": {
"type": "string",
"enum": [
"HANDY_INSPECTION"
],
"nullable": false,
"description": "取得元"
}
},
"required": [
"value",
"unit",
"source"
],
"type": "object",
"additionalProperties": false
},
"ExtECOrderPackingItemDto": {
"properties": {
"ecItemNo": {
"type": "string",
"description": "商品コード"
},
"ecItemName": {
"type": "string",
"description": "商品名"
},
"qty": {
"type": "number",
"format": "double",
"description": "数量"
}
},
"required": [
"ecItemNo",
"ecItemName",
"qty"
],
"type": "object",
"additionalProperties": false
},
"ExtECOrderPackingBoxDto": {
"properties": {
"seqNo": {
"type": "number",
"format": "double",
"description": "箱No"
},
"boxShipId": {
"type": "string",
"description": "箱単位の出荷管理番号"
},
"cartonSize": {
"type": "string",
"nullable": true,
"description": "箱サイズ（三辺直接入力時はnull）"
},
"cartonDimensions": {
"$ref": "#/components/schemas/ExtECOrderPackingCartonDimensionsDto",
"description": "箱の三辺サイズ"
},
"weight": {
"$ref": "#/components/schemas/ExtECOrderPackingWeightDto",
"description": "箱重量"
},
"items": {
"items": {
"$ref": "#/components/schemas/ExtECOrderPackingItemDto"
},
"type": "array",
"description": "箱内の商品明細"
}
},
"required": [
"seqNo",
"boxShipId",
"cartonSize",
"cartonDimensions",
"weight",
"items"
],
"type": "object",
"additionalProperties": false
},
"ExtECOrderPackingResponseDto": {
"properties": {
"custShopCode": {
"type": "string",
"description": "店舗コード"
},
"orderNo": {
"type": "string",
"description": "注文番号"
},
"shipId": {
"type": "string",
"nullable": true,
"description": "出荷管理番号"
},
"shippingTypeCode": {
"type": "string",
"nullable": true,
"description": "出荷区分コード"
},
"volumePackingSplitFlag": {
"type": "boolean",
"description": "容積梱包分割フラグ"
},
"packingStatus": {
"type": "string",
"enum": [
"REGISTERED",
"NOT_REGISTERED"
],
"description": "梱包情報登録ステータス"
},
"packingDataType": {
"type": "string",
"enum": [
"ACTUAL"
],
"nullable": false,
"description": "梱包情報種別"
},
"seqCount": {
"type": "number",
"format": "double",
"description": "箱数"
},
"isSplit": {
"type": "boolean",
"description": "分割有無"
},
"boxes": {
"items": {
"$ref": "#/components/schemas/ExtECOrderPackingBoxDto"
},
"type": "array",
"description": "箱単位の梱包実績"
}
},
"required": [
"custShopCode",
"orderNo",
"shipId",
"shippingTypeCode",
"volumePackingSplitFlag",
"packingStatus",
"seqCount",
"isSplit",
"boxes"
],
"type": "object",
"additionalProperties": false
},
"ExtGetECOrderPackingDto": {
"properties": {
"custShopCode": {
"type": "string",
"description": "店舗コード",
"maxLength": 20
},
"orderNo": {
"type": "string",
"description": "注文番号",
"maxLength": 50
},
"seqNo": {
"type": "number",
"format": "double",
"description": "箱No"
}
},
"required": [
"custShopCode",
"orderNo"
],
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSA_ECOrderCreateToC_ForAPI": {
"properties": {
"message": {
"type": "string",
"enum": [
"会社コードは必須です。",
"店舗コードは必須です。",
"注文番号は必須です。",
"購入者氏名は必須です。",
"購入者郵便番号は必須です。",
"購入者都道府県は必須です。",
"購入者住所1は必須です。",
"購入者電話番号は必須です。",
"お届け先氏名は必須です。",
"お届け先郵便番号は必須です。",
"お届け先都道府県は必須です。",
"お届け先住所1は必須です。",
"お届け先電話番号は必須です。",
"配送方法コードは必須です。",
"支払方法コードは必須です。",
"海外受注フラグは必須です。",
"明細情報は必須です。",
"同一OrderNoが存在します。",
"お届け希望時間帯の入力が正しくありません。",
"購入者郵便番号は10桁以内で入力してください。",
"お届け先郵便番号は10桁以内で入力してください。",
"存在しない郵便番号です。正しい郵便番号を入力してください。",
"代引き不可郵便番号です。",
"指定された都道府県(購入者)は存在しません。",
"指定された都道府県(お届け先)は存在しません。",
"海外向け受注の場合はお届け先と購入者それぞれの国コードの入力が必要です。",
"指定された店舗コードはマスターに存在しません。",
"指定された配送方法コードはマスターに存在しません。または選択不可能な配送方法を指定されています。",
"指定された支払方法コードはマスターに存在しません。",
"指定された配送温度は存在しません。",
"指定された出荷区分コードは利用できません。",
"指定された特殊梱包番号はマスターに存在しません。",
"金額項目「ポイント利用」はマイナスをつけないでください。",
"金額項目「クーポン利用」はマイナスをつけないでください。",
"金額項目「送料」はマイナスをつけないでください。",
"金額項目「代引手数料」はマイナスをつけないでください。",
"金額項目「値引き」はマイナスをつけないでください。",
"金額項目「商品合計金額」はマイナスをつけないでください。",
"金額項目「消費税」はマイナスをつけないでください。",
"金額項目「お支払い総合計」はマイナスをつけないでください。",
"金額項目「合計金額」はマイナスをつけないでください。",
"金額項目「包装手数料」はマイナスをつけないでください。",
"金額項目「その他手数料」はマイナスをつけないでください。",
"同一注文番号内に同じ商品コードが登録されています、同一注文番号内では商品コードを一意にして登録してください。",
"商品コードは必須です。",
"受注数量は必須です。",
"受注数量は1以上で登録してください。",
"金額項目「単価」はマイナスをつけないでください。",
"一括登録できる注文数は最大100件です。現在の件数: 1000件",
"指定された品番はマスターに存在しません。"
]
}
},
"required": [
"message"
],
"type": "object"
},
"ExternalOrderTransporterCodeValue": {
"type": "string",
"enum": [
"9001",
"9002",
"9003",
"1009",
"1001",
"1010",
"1011",
"1002",
"1004",
"1210",
"2001"
],
"description": "【配送方法コード（受注）】
\n9001：おまかせ便(ソフト)
\n9002：おまかせ便(ハード)
\n9003：おまかせ便(ケース出荷)
\n1009：ヤマト運輸 宅急便(ソフト)
\n1001：ヤマト運輸 宅急便(ハード)
\n1010：ヤマト運輸 宅急便EAZY(ソフト)
\n1011：ヤマト運輸 宅急便EAZY(ハード)
\n1002：ヤマト運輸 宅急便コンパクト
\n1004：ヤマト運輸 ネコポス
\n1210：ヤマト運輸 国際宅急便(海外用)
\n2001：佐川急便 飛脚宅配便
"
},
"DeliveryHandoverLocationCodeValue": {
"type": "string",
"enum": [
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17"
],
"description": "【配送指定場所コード】
\n10：対面
\n11：玄関前
\n12：宅配ボックス
\n13：ガスメーターボックス
\n14：物置
\n15：車庫
\n16：自転車かご
\n17：建物内受付／管理人預け
"
},
"YamatoDeliveryTimeCodeValue": {
"type": "string",
"enum": [
"1214",
"1416",
"1618",
"1820",
"1921",
"2021",
"9999",
"0812"
],
"description": "【ヤマト運輸】
\n0812：午前中
\n1214：12～14時
\n1416：14～16時
\n1618：16～18時
\n1820：18～20時
\n1921：19～21時
\n2021：20～21時
\n9999：指定なし
"
},
"SgDeliveryTimeCodeValue": {
"type": "string",
"enum": [
"12",
"14",
"16",
"18",
"19",
"99",
"01",
"04"
],
"description": "【佐川急便】
\n01：午前中
\n04：18～21時
\n12：12～14時
\n14：14～16時
\n16：16～18時
\n18：18～20時
\n19：19～21時
\n99：指定なし
"
},
"OmakaseDeliveryTimeCodeValue": {
"type": "string",
"enum": [
"1214",
"1416",
"1618",
"1820",
"1821",
"1921",
"9999",
"0812"
],
"description": "【おまかせ便】
\n0812：午前中
\n1214：12～14時
\n1416：14～16時
\n1618：16～18時
\n1820：18～20時
\n1821：18～21時
\n1921：19～21時
\n9999：指定なし
"
},
"DeliveryTimeCodeValue": {
"anyOf": [
{
"$ref": "#/components/schemas/YamatoDeliveryTimeCodeValue"
},
{
"$ref": "#/components/schemas/SgDeliveryTimeCodeValue"
},
{
"$ref": "#/components/schemas/OmakaseDeliveryTimeCodeValue"
}
]
},
"ECOrderDetailDto": {
"properties": {
"ecItemNo": {
"type": "string",
"description": "商品コード",
"maxLength": 100
},
"ecItemName": {
"type": "string",
"description": "商品名",
"maxLength": 200
},
"unitPrice": {
"type": "integer",
"format": "int32",
"description": "単価"
},
"qtyOrder": {
"type": "integer",
"format": "int32",
"description": "受注数量"
},
"lineMemo": {
"type": "string",
"description": "受注明細備考",
"maxLength": 100
}
},
"required": [
"ecItemNo",
"qtyOrder"
],
"type": "object",
"additionalProperties": false
},
"ExtCreateToCOrderDto": {
"properties": {
"custShopCode": {
"type": "string",
"description": "店舗コード",
"maxLength": 20
},
"orderNo": {
"type": "string",
"description": "注文番号",
"maxLength": 50
},
"orderName": {
"type": "string",
"description": "購入者名",
"maxLength": 150
},
"orderNameKana": {
"type": "string",
"description": "購入者名（カナ）",
"maxLength": 50
},
"orderCompanyName": {
"type": "string",
"description": "購入者会社名",
"maxLength": 40
},
"orderZipCode": {
"type": "string",
"description": "購入者郵便番号",
"maxLength": 10
},
"orderPrefName": {
"type": "string",
"description": "購入者都道府県名",
"maxLength": 20
},
"orderAddress1": {
"type": "string",
"description": "購入者住所1",
"maxLength": 100
},
"orderAddress2": {
"type": "string",
"description": "購入者住所2",
"maxLength": 100
},
"orderAddress3": {
"type": "string",
"description": "購入者住所3",
"maxLength": 100
},
"orderPhone": {
"type": "string",
"description": "購入者電話番号",
"maxLength": 30
},
"orderFax": {
"type": "string",
"description": "購入者FAX番号",
"maxLength": 30
},
"orderEMail": {
"type": "string",
"description": "購入者メールアドレス",
"maxLength": 300
},
"orderCountryName": {
"type": "string",
"description": "購入者国名",
"maxLength": 20
},
"shippingName": {
"type": "string",
"description": "お届け先名",
"maxLength": 150
},
"shippingNameKana": {
"type": "string",
"description": "お届け先名（カナ）",
"maxLength": 50
},
"shippingCompanyName": {
"type": "string",
"description": "お届け先会社名",
"maxLength": 40
},
"shippingZipCode": {
"type": "string",
"description": "お届け先郵便番号",
"maxLength": 10
},
"shippingPrefName": {
"type": "string",
"description": "お届け先都道府県名",
"maxLength": 20
},
"shippingAddress1": {
"type": "string",
"description": "お届け先住所1",
"maxLength": 100
},
"shippingAddress2": {
"type": "string",
"description": "お届け先住所2",
"maxLength": 100
},
"shippingAddress3": {
"type": "string",
"description": "お届け先住所3",
"maxLength": 100
},
"shippingPhone": {
"type": "string",
"description": "お届け先電話番号",
"maxLength": 30
},
"shippingFax": {
"type": "string",
"description": "お届け先FAX番号",
"maxLength": 30
},
"shippingEMail": {
"type": "string",
"description": "お届け先メールアドレス",
"maxLength": 300
},
"shippingCountryName": {
"type": "string",
"description": "お届け先国名",
"maxLength": 20
},
"transporterCode": {
"$ref": "#/components/schemas/ExternalOrderTransporterCodeValue",
"description": "【受注】UIのB2C（transporter-code-b2c）と同じ
\n9001：おまかせ便(ソフト)
\n9002：おまかせ便(ハード)
\n9003：おまかせ便(ケース出荷)
\n1009：ヤマト運輸 宅急便(ソフト)
\n1001：ヤマト運輸 宅急便(ハード)
\n1010：ヤマト運輸 宅急便EAZY(ソフト)
\n1011：ヤマト運輸 宅急便EAZY(ハード)
\n1002：ヤマト運輸 宅急便コンパクト
\n1004：ヤマト運輸 ネコポス
\n1210：ヤマト運輸 国際宅急便(海外用)
\n2001：佐川急便 飛脚宅配便
"
},
"deliveryHandoverLocationCode": {
"$ref": "#/components/schemas/DeliveryHandoverLocationCodeValue",
"description": "【配送指定場所コード】
\n10：対面
\n11：玄関前
\n12：宅配ボックス
\n13：ガスメーターボックス
\n14：物置
\n15：車庫
\n16：自転車かご
\n17：建物内受付／管理人預け
\n【指定できる配送方法】
\n9001：おまかせ便(ソフト)（対応環境では指定任意）
\n9002：おまかせ便(ハード)（対応環境では指定任意）
\n9003：おまかせ便(ケース出荷)（対応環境では指定任意）
\n1010：ヤマト運輸 宅急便EAZY(ソフト)（指定必須）
\n1011：ヤマト運輸 宅急便EAZY(ハード)（指定必須）
\n2001：佐川急便 飛脚宅配便（指定任意）
\nおまかせ便は出荷グループ作成時に、ヤマトならソフトは1010、ハード・ケース出荷は1011、佐川なら2001へ確定します。
\n上記以外の配送方法では指定できません。"
},
"dateOrder": {
"type": "string",
"description": "受注日付\n例）2026-05-08"
},
"dateDesiredDelivery": {
"type": "string",
"description": "お届け先希望日"
},
"amtPointUsing": {
"type": "number",
"format": "double",
"description": "ポイント利用額"
},
"amtCouponUsing": {
"type": "number",
"format": "double",
"description": "クーポン利用額"
},
"amtShippingCharge": {
"type": "number",
"format": "double",
"description": "送料"
},
"amtDaibikiCharge": {
"type": "number",
"format": "double",
"description": "代引手数料"
},
"amtDiscount": {
"type": "number",
"format": "double",
"description": "値引き額"
},
"amtPurchaseTotal": {
"type": "number",
"format": "double",
"description": "購入総額"
},
"taxCost": {
"type": "number",
"format": "double",
"description": "税金額"
},
"amtPaymentTotal": {
"type": "number",
"format": "double",
"description": "お支払い総合計"
},
"amtTotal": {
"type": "number",
"format": "double",
"description": "合計金額"
},
"amtWrappingCharge": {
"type": "number",
"format": "double",
"description": "ラッピング料金"
},
"amtSundryCharge": {
"type": "number",
"format": "double",
"description": "amtSundryCharge"
},
"paymentMethodCode": {
"$ref": "#/components/schemas/PaymentMethodCodeValue"
},
"orderMemo": {
"type": "string",
"description": "受注メモ",
"maxLength": 700
},
"shippingTagDescription": {
"type": "string",
"description": "送り状特記事項",
"maxLength": 200
},
"deliveryTimeCode": {
"$ref": "#/components/schemas/DeliveryTimeCodeValue"
},
"delivSlipIssueMethodCode": {
"type": "string",
"description": "納品書設定コード\n10: 納品書電子化\n11: 納品書紙発行\n12: 納品書なし\n未指定時は店舗設定を使用します。"
},
"waitForConfirmFlag": {
"type": "boolean",
"description": "出荷保留フラグ"
},
"waitForConfirmReason": {
"type": "string",
"description": "出荷保留理由",
"maxLength": 100
},
"headText10": {
"type": "string",
"description": "受注フリー項目1",
"maxLength": 200
},
"headText11": {
"type": "string",
"description": "受注フリー項目2",
"maxLength": 200
},
"headText12": {
"type": "string",
"description": "受注フリー項目3",
"maxLength": 200
},
"headText13": {
"type": "string",
"description": "受注フリー項目4",
"maxLength": 200
},
"headText14": {
"type": "string",
"description": "受注フリー項目5",
"maxLength": 200
},
"cntPurchased": {
"type": "integer",
"format": "int32",
"description": "購入回数"
},
"cntSubscription": {
"type": "integer",
"format": "int32",
"description": "定期購入回数"
},
"receiptFlag": {
"type": "boolean",
"description": "領収書フラグ"
},
"socialGiftFlag": {
"type": "boolean",
"description": "ソーシャルギフトフラグ\n\nONの場合、納品書・送り状の注文者（購入者）情報をマスクし、領収書を発行しません。"
},
"overseaFlag": {
"type": "boolean",
"description": "海外受注フラグ"
},
"mallOrderNo": {
"type": "string",
"description": "モールID",
"maxLength": 50
},
"volumePackingSplitFlag": {
"type": "boolean",
"description": "体積上限による個口分割フラグ"
},
"ecOrderDtl": {
"items": {
"$ref": "#/components/schemas/ECOrderDetailDto"
},
"type": "array",
"description": "受注明細情報"
}
},
"required": [
"custShopCode",
"orderNo",
"orderName",
"orderZipCode",
"orderPrefName",
"orderAddress1",
"orderPhone",
"shippingName",
"shippingZipCode",
"shippingPrefName",
"shippingAddress1",
"shippingPhone",
"transporterCode",
"dateOrder",
"paymentMethodCode",
"ecOrderDtl"
],
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSA_ECOrderCreateToB_ForAPI": {
"properties": {
"message": {
"type": "string",
"enum": [
"会社コードは必須です。",
"店舗コードは必須です。",
"お届け先IDは必須です。",
"配送方法コードは必須です。",
"明細情報は必須です。",
"同一OrderNoが存在します。",
"指定されたお届け先IDはマスターに存在しません。",
"お届け希望時間帯の入力が正しくありません。",
"指定された店舗コードはマスターに存在しません。",
"指定された配送方法コードはマスターに存在しません。または選択不可能な配送方法を指定されています。",
"指定された出荷区分コードは利用できません。",
"FBA出荷を指定できるのは出荷指示のみです。",
"FBA出荷で指定できる配送方法はグリーンボックスまたはFBA専用ヤマトのみです。",
"同一注文番号内に同じ商品コードが登録されています、同一注文番号内では商品コードを一意にして登録してください。",
"商品コードは必須です。",
"受注数量は必須です。",
"受注数量は1以上で登録してください。",
"金額項目「単価」はマイナスをつけないでください。",
"指定された品番はマスターに存在しません。"
]
}
},
"required": [
"message"
],
"type": "object"
},
"ExternalShipTransporterCodeValue": {
"type": "string",
"enum": [
"9001",
"9002",
"9003",
"1001",
"5016",
"5017",
"5018",
"5019",
"5020",
"5021",
"5022",
"5023",
"4001"
],
"description": "【配送方法コード（出荷）】
\n9001：おまかせ便(ソフト)
\n9002：おまかせ便(ハード)
\n9003：おまかせ便(ケース出荷)
\n1001：ヤマト運輸 宅急便(ハード)
\n5016：(その他)店頭受取
\n5017：(その他)メーカー直送
\n5018：(その他)チャーター便
\n5019：(その他)倉庫内移動
\n5020：(その他)倉庫受取
\n5021：(その他)流通加工指示
\n5022：(その他)廃棄
\n5023：(その他)FBA専用ヤマト運輸
\n4001：グリーンボックス
"
},
"ExtCreateToBOrderDto": {
"properties": {
"custShopCode": {
"type": "string",
"description": "店舗コード",
"maxLength": 20
},
"orderNo": {
"type": "string",
"description": "注文番号",
"maxLength": 50
},
"ecCustomerCode": {
"type": "string",
"description": "届け先マスタコード"
},
"transporterCode": {
"$ref": "#/components/schemas/ExternalShipTransporterCodeValue",
"description": "【出荷指示】UIのB2B（transporter-code-b2b）と同じ
\n9001：おまかせ便(ソフト)
\n9002：おまかせ便(ハード)
\n9003：おまかせ便(ケース出荷)
\n1001：ヤマト運輸 宅急便(ハード)
\n5016：(その他)店頭受取
\n5017：(その他)メーカー直送
\n5018：(その他)チャーター便
\n5019：(その他)倉庫内移動
\n5020：(その他)倉庫受取
\n5021：(その他)流通加工指示
\n5022：(その他)廃棄
\n5023：(その他)FBA専用ヤマト運輸
\n4001：グリーンボックス
"
},
"dateOrder": {
"type": "string",
"description": "受注日付\n例）2026-05-08"
},
"dateDesiredDelivery": {
"type": "string",
"description": "お届け先希望日"
},
"dateCredit": {
"type": "string",
"description": "取引日付"
},
"shippingTagDescription": {
"type": "string",
"description": "送り状特記事項",
"maxLength": 200
},
"deliveryTimeCode": {
"anyOf": [
{
"$ref": "#/components/schemas/YamatoDeliveryTimeCodeValue"
},
{
"$ref": "#/components/schemas/OmakaseDeliveryTimeCodeValue"
}
]
},
"delivSlipIssueMethodCode": {
"type": "string",
"description": "納品書設定コード\n10: 納品書電子化\n11: 納品書紙発行\n12: 納品書なし\n未指定時は店舗設定を使用します。"
},
"mallOrderNo": {
"type": "string",
"description": "モールID",
"maxLength": 50
},
"volumePackingSplitFlag": {
"type": "boolean",
"description": "体積上限による個口分割フラグ"
},
"shippingTypeCode": {
"type": "string",
"description": "出荷区分コード\n100: 通常出荷\n110: FBA出荷\n未指定時は通常出荷として扱います。",
"maxLength": 3
},
"headText10": {
"type": "string",
"description": "受注フリー項目1",
"maxLength": 200
},
"headText11": {
"type": "string",
"description": "受注フリー項目2",
"maxLength": 200
},
"headText12": {
"type": "string",
"description": "受注フリー項目3",
"maxLength": 200
},
"headText13": {
"type": "string",
"description": "受注フリー項目4",
"maxLength": 200
},
"headText14": {
"type": "string",
"description": "受注フリー項目5",
"maxLength": 200
},
"ecOrderDtl": {
"items": {
"$ref": "#/components/schemas/ECOrderDetailDto"
},
"type": "array",
"description": "受注明細情報"
}
},
"required": [
"custShopCode",
"ecCustomerCode",
"transporterCode",
"ecOrderDtl"
],
"type": "object",
"additionalProperties": false
},
"ExtSavedFbaLabelFileDto": {
"properties": {
"fileNo": {
"type": "number",
"format": "double",
"description": "添付ファイル番号"
},
"fbaLabelNo": {
"type": "string",
"nullable": true,
"description": "FBAラベル番号"
},
"fileUrl": {
"type": "string",
"description": "Blob保存後のPDFファイルURL"
},
"originalFileName": {
"type": "string",
"nullable": true,
"description": "元ファイル名"
}
},
"required": [
"fileNo",
"fbaLabelNo",
"fileUrl",
"originalFileName"
],
"type": "object",
"additionalProperties": false
},
"ExtSaveFbaLabelFilesResponseDto": {
"properties": {
"custShopCode": {
"type": "string",
"description": "店舗コード"
},
"orderNo": {
"type": "string",
"description": "注文番号"
},
"updatedFiles": {
"items": {
"$ref": "#/components/schemas/ExtSavedFbaLabelFileDto"
},
"type": "array",
"description": "登録・更新したFBAラベルPDFファイル"
}
},
"required": [
"custShopCode",
"orderNo",
"updatedFiles"
],
"type": "object",
"additionalProperties": false
},
"ExtSaveFbaLabelFileItemDto": {
"properties": {
"fbaLabelNo": {
"type": "string",
"description": "FBAラベル番号"
},
"fileUrl": {
"type": "string",
"description": "PDFファイルURL"
},
"originalFileName": {
"type": "string",
"description": "元ファイル名"
},
"contentType": {
"type": "string",
"description": "Content-Type"
}
},
"required": [
"fileUrl"
],
"type": "object",
"additionalProperties": false
},
"ExtSaveFbaLabelFilesDto": {
"properties": {
"custShopCode": {
"type": "string",
"description": "店舗コード"
},
"orderNo": {
"type": "string",
"description": "注文番号"
},
"files": {
"items": {
"$ref": "#/components/schemas/ExtSaveFbaLabelFileItemDto"
},
"type": "array",
"description": "FBAラベルPDFファイル情報"
}
},
"required": [
"custShopCode",
"orderNo",
"files"
],
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSA_ECOrderUpdate_ForAPI": {
"properties": {
"message": {
"type": "string",
"enum": [
"会社コードは必須です。",
"店舗コードは必須です。",
"注文番号は必須です。",
"購入者氏名は必須です。",
"購入者郵便番号は必須です。",
"購入者都道府県は必須です。",
"購入者住所1は必須です。",
"購入者電話番号は必須です。",
"お届け先氏名は必須です。",
"お届け先郵便番号は必須です。",
"お届け先都道府県は必須です。",
"お届け先住所1は必須です。",
"お届け先電話番号は必須です。",
"配送方法コードは必須です。",
"支払方法コードは必須です。",
"選択された受注情報が存在しない為更新できません。",
"出荷作業中以降のデーターは更新できません。",
"出荷準備に入ったデーターの為、更新できません。カスタマーサービス宛てにご連絡ください。",
"同梱候補データーは更新できません。",
"同梱データーの為、支払方法を代引にはできません。",
"配送方法を変更することはできません。",
"ヤマト代引きに変更できません。代引きをご希望の際は佐川急便を指定してください。",
"購入者郵便番号は10桁以内で入力してください。",
"お届け先郵便番号は10桁以内で入力してください。",
"存在しない郵便番号です。正しい郵便番号を入力してください。",
"代引き不可郵便番号です。",
"指定された都道府県(購入者)は存在しません。",
"指定された都道府県(お届け先)は存在しません。",
"海外向け受注の場合はお届け先と購入者それぞれの国コードの入力が必要です。",
"指定された配送方法コードはマスターに存在しません。または選択不可能な配送方法を指定されています。",
"指定された支払方法コードはマスターに存在しません。",
"指定された配送温度は存在しません。",
"指定された出荷区分コードは利用できません。",
"FBA出荷を指定できるのは出荷指示のみです。",
"FBA出荷で指定できる配送方法はグリーンボックスまたはFBA専用ヤマトのみです。",
"指定された特殊梱包番号はマスターに存在しません。",
"金額項目「ポイント利用」はマイナスをつけないでください。",
"金額項目「クーポン利用」はマイナスをつけないでください。",
"金額項目「送料」はマイナスをつけないでください。",
"金額項目「代引手数料」はマイナスをつけないでください。",
"金額項目「値引き」はマイナスをつけないでください。",
"金額項目「商品合計金額」はマイナスをつけないでください。",
"金額項目「消費税」はマイナスをつけないでください。",
"金額項目「お支払い総合計」はマイナスをつけないでください。",
"金額項目「合計金額」はマイナスをつけないでください。",
"金額項目「包装手数料」はマイナスをつけないでください。",
"金額項目「その他手数料」はマイナスをつけないでください。"
]
}
},
"required": [
"message"
],
"type": "object"
},
"UpdateDeliveryHandoverLocationCodeValue": {
"anyOf": [
{
"$ref": "#/components/schemas/DeliveryHandoverLocationCodeValue"
},
{
"type": "string",
"enum": [
""
]
}
],
"description": "【配送指定場所コード（更新）】
\n10：対面
\n11：玄関前
\n12：宅配ボックス
\n13：ガスメーターボックス
\n14：物置
\n15：車庫
\n16：自転車かご
\n17：建物内受付／管理人預け
\n空文字：指定解除
"
},
"ExtUpdateECOrderDto": {
"properties": {
"orderNo": {
"type": "string",
"description": "注文番号"
},
"orderName": {
"type": "string",
"description": "購入者名"
},
"orderNameKana": {
"type": "string",
"description": "購入者名（カナ）"
},
"orderCompanyName": {
"type": "string",
"description": "購入者会社名"
},
"orderZipCode": {
"type": "string",
"description": "購入者郵便番号"
},
"orderPrefName": {
"type": "string",
"description": "購入者都道府県名"
},
"orderAddress1": {
"type": "string",
"description": "購入者住所1"
},
"orderAddress2": {
"type": "string",
"description": "購入者住所2"
},
"orderAddress3": {
"type": "string",
"description": "購入者住所3"
},
"orderPhone": {
"type": "string",
"description": "購入者電話番号"
},
"orderFax": {
"type": "string",
"description": "購入者FAX番号"
},
"orderEMail": {
"type": "string",
"description": "購入者メールアドレス"
},
"orderCountryName": {
"type": "string",
"description": "購入者国名"
},
"shippingName": {
"type": "string",
"description": "お届け先名"
},
"shippingNameKana": {
"type": "string",
"description": "お届け先名（カナ）"
},
"shippingCompanyName": {
"type": "string",
"description": "お届け先会社名"
},
"shippingZipCode": {
"type": "string",
"description": "お届け先郵便番号"
},
"shippingPrefName": {
"type": "string",
"description": "お届け先都道府県名"
},
"shippingAddress1": {
"type": "string",
"description": "お届け先住所1"
},
"shippingAddress2": {
"type": "string",
"description": "お届け先住所2"
},
"shippingAddress3": {
"type": "string",
"description": "お届け先住所3"
},
"shippingEMail": {
"type": "string",
"description": "お届け先メールアドレス"
},
"shippingPhone": {
"type": "string",
"description": "お届け先電話番号"
},
"shippingFax": {
"type": "string",
"description": "お届け先FAX番号"
},
"shippingCountryName": {
"type": "string",
"description": "お届け先国名"
},
"transporterCode": {
"$ref": "#/components/schemas/TransporterCodeValue",
"description": "運送会社コード"
},
"deliveryHandoverLocationCode": {
"$ref": "#/components/schemas/UpdateDeliveryHandoverLocationCodeValue",
"description": "【配送指定場所コード】
\n10：対面
\n11：玄関前
\n12：宅配ボックス
\n13：ガスメーターボックス
\n14：物置
\n15：車庫
\n16：自転車かご
\n17：建物内受付／管理人預け
\n【指定できる配送方法】
\n9001：おまかせ便(ソフト)（対応環境では指定任意・空文字で解除）
\n9002：おまかせ便(ハード)（対応環境では指定任意・空文字で解除）
\n9003：おまかせ便(ケース出荷)（対応環境では指定任意・空文字で解除）
\n1010：ヤマト運輸 宅急便EAZY(ソフト)（指定必須・解除不可）
\n1011：ヤマト運輸 宅急便EAZY(ハード)（指定必須・解除不可）
\n2001：佐川急便 飛脚宅配便（指定任意・空文字で解除）
\n項目を省略した場合は現在の指定を維持します。
\n上記以外の配送方法では指定できません。"
},
"dateDesiredDelivery": {
"type": "string",
"description": "お届け先希望日"
},
"amtPointUsing": {
"type": "integer",
"format": "int32",
"description": "ポイント利用額"
},
"amtCouponUsing": {
"type": "integer",
"format": "int32",
"description": "クーポン利用額"
},
"amtShippingCharge": {
"type": "integer",
"format": "int32",
"description": "送料"
},
"amtDaibikiCharge": {
"type": "integer",
"format": "int32",
"description": "代引手数料"
},
"amtDiscount": {
"type": "integer",
"format": "int32",
"description": "値引き額"
},
"amtPurchaseTotal": {
"type": "integer",
"format": "int32",
"description": "購入総額"
},
"taxCost": {
"type": "integer",
"format": "int32",
"description": "税金額"
},
"amtPaymentTotal": {
"type": "integer",
"format": "int32",
"description": "お支払い総合計"
},
"amtTotal": {
"type": "integer",
"format": "int32",
"description": "合計金額"
},
"amtWrappingCharge": {
"type": "integer",
"format": "int32",
"description": "ラッピング料金"
},
"amtSundryCharge": {
"type": "integer",
"format": "int32",
"description": "その他手数料"
},
"paymentMethodCode": {
"$ref": "#/components/schemas/PaymentMethodCodeValue",
"description": "支払方法コード"
},
"orderMemo": {
"type": "string",
"description": "受注メモ"
},
"shippingTagDescription": {
"type": "string",
"description": "送り状特記事項"
},
"deliveryTimeCode": {
"$ref": "#/components/schemas/DeliveryTimeCodeValue"
},
"delivSlipIssueMethodCode": {
"type": "string",
"description": "納品書設定コード\n10: 納品書電子化\n11: 納品書紙発行\n12: 納品書なし\n未指定時は更新しません（既存値を保持します）。"
},
"waitForConfirmFlag": {
"type": "boolean",
"description": "出荷保留フラグ"
},
"waitForConfirmReason": {
"type": "string",
"description": "出荷保留理由"
},
"headText10": {
"type": "string",
"description": "受注フリー項目1"
},
"headText11": {
"type": "string",
"description": "受注フリー項目2"
},
"headText12": {
"type": "string",
"description": "受注フリー項目3"
},
"headText13": {
"type": "string",
"description": "受注フリー項目4"
},
"headText14": {
"type": "string",
"description": "受注フリー項目5"
},
"cntPurchased": {
"type": "integer",
"format": "int32",
"description": "購入回数"
},
"cntSubscription": {
"type": "integer",
"format": "int32",
"description": "定期購入回数"
},
"receiptFlag": {
"type": "boolean",
"description": "領収書フラグ"
},
"socialGiftFlag": {
"type": "boolean",
"description": "ソーシャルギフトフラグ\n\nONの場合、納品書・送り状の注文者（購入者）情報をマスクし、領収書を発行しません。"
},
"receiptName": {
"type": "string",
"description": "領収書名"
},
"honorific": {
"type": "string",
"description": "敬称"
},
"receiptDescription": {
"type": "string",
"description": "領収書説明"
},
"amtReceipt": {
"type": "integer",
"format": "int32",
"description": "領収書金額"
},
"dateReceipt": {
"type": "string",
"description": "領収書日付"
},
"orderOptionNo": {
"type": "string",
"description": "特殊梱包番号"
},
"volumePackingSplitFlag": {
"type": "boolean",
"description": "体積上限による個口分割フラグ"
},
"shippingTypeCode": {
"type": "string",
"description": "出荷区分コード\n100: 通常出荷\n110: FBA出荷\n未指定時は更新しません（既存値を保持します）。",
"maxLength": 3
}
},
"required": [
"orderNo"
],
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSP_ECOrderCancel": {
"properties": {
"message": {
"type": "string",
"enum": [
"処理できません。 該当受注データーは出荷済み以前のデータに存在しません。",
"処理できません。 該当受注データーには 「〇〇〇」 の進捗が含まれています。"
]
}
},
"required": [
"message"
],
"type": "object"
},
"ExtCancelECOrderDto": {
"properties": {
"orderNo": {
"type": "string",
"description": "注文番号"
}
},
"required": [
"orderNo"
],
"type": "object",
"additionalProperties": false
},
"ExtReflectEcCancellationResponseDto": {
"description": "ECサイト側（EC購入者）キャンセルのSTOCKCREW反映結果。\n進捗を見て「出荷を止める」ことだけを行い、楽天など各モールへの取消実行は行わない。",
"properties": {
"outcome": {
"type": "string",
"enum": [
"held",
"cancellation_requested",
"already_processed",
"skipped"
],
"description": "反映結果の区分。受注の進捗に応じて自動で振り分けられる。\n- held: 出荷待ち以前のため削除せず理由付きで保留した（他の保留理由がある場合は上書きしない）\n- cancellation_requested: 出荷作業中以降のため出荷キャンセル依頼を登録した（倉庫のJ40出荷キャンセルで完了する）\n- already_processed: 既にECサイト側キャンセルとして反映済みだった（再検知。手動解除を尊重し再適用しない）\n- skipped: 対象外のため何もしなかった（detail に理由）"
},
"detail": {
"type": "string",
"description": "skipped の理由など補足。例: not_found（該当受注なし）/ shipped（出荷済み）/ cancelled（取消済み）"
}
},
"required": [
"outcome"
],
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfDelivSlipNotFound": {
"properties": {
"message": {
"type": "string",
"enum": [
"該当する納品書が見つかりませんでした。",
"サーバーエラーが発生しました。"
]
}
},
"required": [
"message"
],
"type": "object"
},
"SiteCodeValue": {
"type": "string",
"enum": [
"1000",
"1050",
"1100",
"1150",
"1160",
"1170",
"1200",
"1250",
"1260",
"1270",
"1300",
"1350",
"1360",
"1370"
],
"description": "【倉庫コード】
\n1000：Yashio Dock
\n1050：B-Yashio Dock
\n1100：Chiba Dock
\n1150：B-Chiba Dock
\n1160：R-Chiba Dock
\n1170：調査中在庫
\n1200：Chiba Central Dock
\n1250：B-Chiba Central Dock
\n1260：R-Chiba Central Dock
\n1270：CCD調査中在庫
\n1300：Central Dock 5F
\n1350：B-Chiba Central Dock 5F
\n1360：R-Chiba Central Dock 5F
\n1370：CCD調査中在庫-5F
"
},
"ExtInventoryResponseDto": {
"properties": {
"gtinCode": {
"type": "string",
"description": "物流ID"
},
"itemNo": {
"type": "string",
"description": "商品コード"
},
"itemName": {
"type": "string",
"nullable": true,
"description": "商品名"
},
"dateExpiration": {
"type": "string",
"nullable": true,
"description": "商品の有効期限"
},
"dateShippingDeadline": {
"type": "string",
"nullable": true,
"description": "出荷締切日"
},
"dateStockUpdate": {
"type": "string",
"nullable": true,
"description": "在庫数変動日"
},
"qtyArrival": {
"type": "integer",
"format": "int32",
"description": "入荷待ち数量"
},
"qtyStock": {
"type": "integer",
"format": "int32",
"description": "在庫数量"
},
"qtyStockFree": {
"type": "integer",
"format": "int32",
"description": "引当されていない在庫数"
},
"qtySalesStock": {
"type": "integer",
"format": "int32",
"description": "販売在庫数（バッファ控除後）"
},
"qtyAllocateAll": {
"type": "integer",
"format": "int32",
"description": "総引当済み数量"
},
"qtyWaitAllocate": {
"type": "integer",
"format": "int32",
"description": "引当待ちの数量"
},
"qtyShipping": {
"type": "integer",
"format": "int32",
"description": "出荷作業中の数量"
},
"shippingPointCode": {
"$ref": "#/components/schemas/ShippingPointCodeValue"
},
"shippingPointName": {
"type": "string",
"description": "出荷場所名"
},
"siteCode": {
"$ref": "#/components/schemas/SiteCodeValue"
},
"siteName": {
"type": "string",
"description": "倉庫名"
},
"itemTypeName": {
"type": "string",
"description": "商品区分名"
},
"unitRetailPrice": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "商品の小売単価"
},
"unitCostPrice": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "商品の原価"
},
"itemGroupName": {
"type": "string",
"nullable": true,
"description": "カテゴリ名"
},
"threeM": {
"type": "integer",
"format": "int32",
"description": "商品の総サイズ（幅＋奥行き＋高さ）"
}
},
"required": [
"gtinCode",
"itemNo",
"itemName",
"dateExpiration",
"dateShippingDeadline",
"dateStockUpdate",
"qtyArrival",
"qtyStock",
"qtyStockFree",
"qtyAllocateAll",
"qtyWaitAllocate",
"qtyShipping",
"shippingPointCode",
"shippingPointName",
"siteCode",
"siteName",
"itemTypeName",
"unitRetailPrice",
"unitCostPrice",
"itemGroupName",
"threeM"
],
"type": "object",
"additionalProperties": false
},
"ItemTypeCodeValue": {
"type": "string",
"enum": [
"100",
"500",
"510",
"511",
"520"
],
"description": "【商品区分コード】
\n100：商品
\n500：チラシ
\n510：梱包資材(大)
\n511：梱包資材(小)
\n520：特殊梱包資材
"
},
"ExtGetInventoryDto": {
"properties": {
"itemNo": {
"type": "string",
"description": "商品コード",
"maxLength": 100
},
"gtinCode": {
"type": "string",
"description": "物流ID",
"maxLength": 20
},
"siteCode": {
"$ref": "#/components/schemas/SiteCodeValue"
},
"itemTypeCode": {
"$ref": "#/components/schemas/ItemTypeCodeValue"
},
"dateShippingDeadlineFrom": {
"type": "string",
"description": "出荷締切日（開始）",
"maxLength": 10
},
"dateShippingDeadlineTo": {
"type": "string",
"description": "出荷締切日（終了）",
"maxLength": 10
},
"dateStockUpdateFrom": {
"type": "string",
"description": "在庫数変動日\n指定日の0時（JST）以降に在庫数が変動した商品だけを返却します。"
},
"showArrivalFlag": {
"type": "boolean",
"description": "入荷待ち在庫を表示するかどうか",
"default": false
},
"showQtyZeroFlag": {
"type": "boolean",
"description": "在庫数ゼロの商品も表示するかどうか",
"default": false
},
"showQtyWaitAllocate": {
"type": "boolean",
"description": "欠品在庫を表示するかどうか。",
"default": false
}
},
"type": "object",
"additionalProperties": false
},
"SetItemDetailResponse": {
"properties": {
"setItemNo": {
"type": "string",
"nullable": true,
"description": "セット商品の構成商品コード"
},
"qtyInSet": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "セット商品の構成数"
}
},
"required": [
"setItemNo",
"qtyInSet"
],
"type": "object",
"additionalProperties": false
},
"ExtItemResponseDto": {
"properties": {
"gtinCode": {
"type": "string",
"description": "物流ID"
},
"itemNo": {
"type": "string",
"description": "商品コード"
},
"itemName": {
"type": "string",
"nullable": true,
"description": "商品名"
},
"itemGroupCode": {
"type": "string",
"nullable": true,
"description": "カテゴリコード"
},
"supplierCode": {
"type": "string",
"description": "仕入先コード"
},
"unitRetailPrice": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "販売価格 (JPY)"
},
"unitCostPrice": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "原価 (JPY)"
},
"salesPageURL": {
"type": "string",
"description": "商品画像URL"
},
"sizeW": {
"type": "number",
"format": "double",
"nullable": true,
"description": "幅"
},
"sizeH": {
"type": "number",
"format": "double",
"nullable": true,
"description": "高さ"
},
"sizeD": {
"type": "number",
"format": "double",
"nullable": true,
"description": "奥行"
},
"weight": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "重さ"
},
"shippingTagContentsName": {
"type": "string",
"description": "内容品欄"
},
"itemMemo": {
"type": "string",
"nullable": true,
"description": "備考"
},
"itemGroupName": {
"type": "string",
"description": "カテゴリ名"
},
"supplierName": {
"type": "string",
"description": "仕入先名"
},
"transporterName": {
"type": "string",
"nullable": true,
"description": "運送会社名"
},
"setItemFlag": {
"type": "boolean",
"description": "セット商品の構成商品更新フラグ"
},
"itemTypeCode": {
"$ref": "#/components/schemas/ItemTypeCodeValue",
"description": "商品区分コード"
},
"itemTypeName": {
"type": "string",
"nullable": true,
"description": "商品区分名"
},
"setItemNo": {
"type": "string",
"nullable": true,
"description": "セット商品の構成商品コード"
},
"qtyInSet": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "セット商品の構成数"
},
"qtyPOPoint": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "発注点"
},
"qtyPOLot": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "発注ロット"
},
"qtySalesBuffer": {
"type": "integer",
"format": "int32",
"description": "販売在庫バッファ数"
},
"foreignItemFlag": {
"type": "boolean",
"description": "海外向け商品フラグ"
},
"hSCode": {
"type": "string",
"nullable": true,
"description": "HSコード"
},
"productHSDescription1": {
"type": "string",
"nullable": true,
"description": "アイテム(大分類)"
},
"productHSDescription2": {
"type": "string",
"nullable": true,
"description": "アイテム(中分類/危険物有無)"
},
"originCountryCode": {
"type": "string",
"nullable": true,
"description": "原作国"
},
"idManageFlag": {
"type": "boolean",
"description": "ロット管理商品フラグ"
},
"caseShippingFlag": {
"type": "boolean",
"description": "ケース出荷フラグ (false: 対象外, true: 対象)"
},
"foldNekoposFlag": {
"type": "boolean",
"description": "折ってネコポス (false: 対象外, true: 対象)"
},
"checkDateExpirationFlag": {
"type": "boolean",
"description": "消費期限確認商品フラグ"
},
"daysBeforeShippingDeadline": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "出荷期限デフォルト日数(何日前)"
},
"setItemDtl": {
"items": {
"$ref": "#/components/schemas/SetItemDetailResponse"
},
"type": "array",
"description": "セット商品構成商品情報"
}
},
"required": [
"gtinCode",
"itemNo",
"itemName",
"itemGroupCode",
"supplierCode",
"unitRetailPrice",
"unitCostPrice",
"salesPageURL",
"sizeW",
"sizeH",
"sizeD",
"weight",
"shippingTagContentsName",
"itemMemo",
"itemGroupName",
"supplierName",
"transporterName",
"setItemFlag",
"itemTypeCode",
"itemTypeName",
"setItemNo",
"qtyInSet",
"qtyPOPoint",
"qtyPOLot",
"foreignItemFlag",
"hSCode",
"productHSDescription1",
"productHSDescription2",
"originCountryCode",
"idManageFlag",
"caseShippingFlag",
"foldNekoposFlag",
"checkDateExpirationFlag",
"daysBeforeShippingDeadline",
"setItemDtl"
],
"type": "object",
"additionalProperties": false
},
"ExtGetItemDto": {
"properties": {
"itemNo": {
"type": "string",
"description": "商品コード",
"default": "",
"maxLength": 100
},
"itemName": {
"type": "string",
"description": "商品名",
"default": "",
"maxLength": 300
},
"supplierCode": {
"type": "string",
"description": "仕入先コード",
"default": "100",
"maxLength": 20
},
"gtinCode": {
"type": "string",
"description": "物流ID",
"maxLength": 20
},
"itemTypeCode": {
"$ref": "#/components/schemas/ItemTypeCodeValue"
},
"setItemFlag": {
"type": "boolean",
"description": "セット商品のみ表示する"
}
},
"type": "object",
"additionalProperties": false
},
"ItemGroupCodeValue": {
"type": "string",
"enum": [
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"99"
],
"description": "【カテゴリコード】
\n11: DVD・ミュージック・ゲーム
\n12: 家電・カメラ・AV機器
\n13: パソコン・オフィス用品
\n14: ホーム＆キッチン・ペット・DIY
\n15: 食品・飲料・お酒
\n16: ドラッグストア・ビューティー
\n17: ベビー・おもちゃ・ホビー
\n18: 服・シューズ・バック・腕時計
\n19: スポーツ・アウトドア
\n20: 本・コミック・雑誌
\n99: その他
"
},
"SetItemDetailDto": {
"properties": {
"setItemNo": {
"type": "string",
"nullable": true,
"description": "セット商品の構成商品コード",
"maxLength": 100
},
"qtyInSet": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "セット商品の構成数"
}
},
"required": [
"setItemNo",
"qtyInSet"
],
"type": "object",
"additionalProperties": false
},
"ExtCreateItemDto": {
"properties": {
"itemNo": {
"type": "string",
"description": "商品コード",
"maxLength": 100
},
"itemName": {
"type": "string",
"description": "商品名",
"maxLength": 300
},
"itemGroupCode": {
"$ref": "#/components/schemas/ItemGroupCodeValue"
},
"itemTypeCode": {
"$ref": "#/components/schemas/ItemTypeCodeValue"
},
"supplierCode": {
"type": "string",
"description": "仕入先コード",
"maxLength": 20
},
"qtyPOPoint": {
"type": "integer",
"format": "int32",
"description": "発注点"
},
"qtyPOLot": {
"type": "integer",
"format": "int32",
"description": "発注ロット"
},
"qtySalesBuffer": {
"type": "integer",
"format": "int32",
"description": "販売在庫バッファ数（全販路共通、0で解除。更新時の省略は既存値を保持）",
"minimum": 0,
"maximum": 2147483647
},
"unitRetailPrice": {
"type": "integer",
"format": "int32",
"description": "販売価格 (JPY)"
},
"unitCostPrice": {
"type": "integer",
"format": "int32",
"description": "原価 (JPY)"
},
"shippingTagContentsName": {
"type": "string",
"description": "内容品欄",
"maxLength": 50
},
"sizeW": {
"type": "number",
"format": "double",
"description": "幅"
},
"sizeH": {
"type": "number",
"format": "double",
"description": "高さ"
},
"sizeD": {
"type": "number",
"format": "double",
"description": "奥行"
},
"salesPageURL": {
"type": "string",
"description": "商品画像URL",
"maxLength": 1000
},
"gtinCode": {
"type": "string",
"description": "物流ID",
"maxLength": 20
},
"itemMemo": {
"type": "string",
"description": "備考",
"maxLength": 50
},
"foreignItemFlag": {
"type": "boolean",
"description": "海外向け商品フラグ"
},
"hSCode": {
"type": "string",
"description": "HSコード",
"maxLength": 30
},
"productHSDescription1": {
"type": "string",
"description": "アイテム(大分類)",
"maxLength": 50
},
"productHSDescription2": {
"type": "string",
"description": "アイテム(中分類/危険物有無)",
"maxLength": 50
},
"originCountryCode": {
"type": "string",
"description": "原作国",
"maxLength": 3
},
"idManageFlag": {
"type": "boolean",
"description": "ロット管理商品フラグ"
},
"caseShippingFlag": {
"type": "boolean",
"description": "ケース出荷フラグ (false: 対象外, true: 対象)"
},
"foldNekoposFlag": {
"type": "boolean",
"description": "折ってネコポス (false: 対象外, true: 対象)"
},
"checkDateExpirationFlag": {
"type": "boolean",
"description": "消費期限確認商品フラグ"
},
"daysBeforeShippingDeadline": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "出荷期限デフォルト日数(何日前)"
},
"setItemFlag": {
"type": "boolean",
"description": "セット商品の構成商品更新フラグ"
},
"setItemDtl": {
"items": {
"$ref": "#/components/schemas/SetItemDetailDto"
},
"type": "array",
"description": "セット商品構成商品情報"
}
},
"required": [
"itemNo",
"itemName",
"itemGroupCode",
"itemTypeCode",
"shippingTagContentsName"
],
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSA_ItemMasterUpdate_ForAPI": {
"properties": {
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"会社コードは必須です。",
"商品コードは必須です。",
"商品名は必須です。",
"カテゴリは必須です。",
"内容品欄は必須です。",
"仕入先コードは必須です(空文字は指定できません)。",
"選択された商品情報が存在しない為更新できません。",
"セット構成商品の更新はセット商品でのみ可能です。",
"セット構成商品の更新を行う場合、セット商品構成情報は必須です。",
"構成商品に同一商品が複数行指定されています。同じ構成商品は1つにおまとめください。",
"セット商品の場合、仕入先コードは指定できません。",
"セット商品の場合、発注点は指定できません。",
"セット商品の場合、発注ロットは指定できません。",
"海外向け商品の場合、HSコードは必須です。",
"海外向け商品の場合、原産国は必須です。",
"海外向け商品の場合、アイテム(大分類)は必須です。",
"海外向け商品の場合、アイテム(中分類/危険物有無)は必須です。",
"指定された配送方法コードはマスターに存在しません。または選択不可能な配送方法を指定されています。",
"指定されたカテゴリコードはマスターに存在しません。",
"指定された仕入先コードは存在しません。",
"金額項目「販売価格 (JPY)」はマイナスをつけないでください。",
"金額項目「原価 (JPY)」はマイナスをつけないでください。",
"HSコードは半角数字で入力ください。",
"構成商品の商品コードは必須です。",
"構成商品の数量は必須です。",
"構成商品の数量は1以上で登録してください。",
"構成商品に指定された品番はマスターに存在しません。",
"構成商品 ○○○ はセット商品であるため、登録できません。"
]
}
]
}
},
"required": [
"message"
],
"type": "object"
},
"ExtUpdateItemDto": {
"properties": {
"itemName": {
"type": "string",
"description": "商品名",
"maxLength": 300
},
"itemGroupCode": {
"$ref": "#/components/schemas/ItemGroupCodeValue"
},
"supplierCode": {
"type": "string",
"description": "仕入先コード",
"maxLength": 20
},
"qtyPOPoint": {
"type": "integer",
"format": "int32",
"description": "発注点"
},
"qtyPOLot": {
"type": "integer",
"format": "int32",
"description": "発注ロット"
},
"qtySalesBuffer": {
"type": "integer",
"format": "int32",
"description": "販売在庫バッファ数（全販路共通、0で解除。更新時の省略は既存値を保持）",
"minimum": 0,
"maximum": 2147483647
},
"unitRetailPrice": {
"type": "integer",
"format": "int32",
"description": "販売価格 (JPY)"
},
"unitCostPrice": {
"type": "integer",
"format": "int32",
"description": "原価 (JPY)"
},
"shippingTagContentsName": {
"type": "string",
"description": "内容品欄",
"maxLength": 50
},
"sizeW": {
"type": "number",
"format": "double",
"description": "幅"
},
"sizeH": {
"type": "number",
"format": "double",
"description": "高さ"
},
"sizeD": {
"type": "number",
"format": "double",
"description": "奥行"
},
"salesPageURL": {
"type": "string",
"description": "商品画像URL",
"maxLength": 1000
},
"itemMemo": {
"type": "string",
"description": "備考",
"maxLength": 50
},
"foreignItemFlag": {
"type": "boolean",
"description": "海外向け商品フラグ"
},
"hSCode": {
"type": "string",
"description": "HSコード",
"maxLength": 30
},
"productHSDescription1": {
"type": "string",
"description": "アイテム(大分類)",
"maxLength": 50
},
"productHSDescription2": {
"type": "string",
"description": "アイテム(中分類/危険物有無)",
"maxLength": 50
},
"originCountryCode": {
"type": "string",
"description": "原作国",
"maxLength": 3
},
"idManageFlag": {
"type": "boolean",
"description": "ロット管理商品フラグ"
},
"caseShippingFlag": {
"type": "boolean",
"description": "ケース出荷フラグ (false: 対象外, true: 対象)"
},
"foldNekoposFlag": {
"type": "boolean",
"description": "折ってネコポス (false: 対象外, true: 対象)"
},
"checkDateExpirationFlag": {
"type": "boolean",
"description": "消費期限確認商品フラグ"
},
"daysBeforeShippingDeadline": {
"type": "integer",
"format": "int32",
"description": "出荷期限デフォルト日数(何日前)"
},
"setItemUpdateFlag": {
"type": "boolean",
"description": "セット商品の構成商品更新フラグ"
},
"setItemDtl": {
"items": {
"$ref": "#/components/schemas/SetItemDetailDto"
},
"type": "array",
"description": "セット商品構成商品情報"
}
},
"type": "object",
"additionalProperties": false
},
"ErrorMessageOfSA_ItemMasterCancel_ForAPI": {
"properties": {
"message": {
"type": "string",
"enum": [
"処理できません。 該当データは存在しません。",
"受注データが存在するため削除できませんでした。",
"入荷予定(入荷実績)データが存在するため削除できませんでした。"
]
}
},
"required": [
"message"
],
"type": "object"
}
},
"securitySchemes": {}
},
"info": {
"title": "External API",
"version": "1.0.0",
"description": "\n # STOCKCREWのWEB API\n ### 提供API\n STOCKCREWのWEB APIは、以下の機能を提供します。\n - 入荷\n - 出荷\n - 在庫\n - 商品マスタ\n - その他\n ### 利用方法\n STOCKCREW APIを利用するにはAPIキーが必要となります。\n\n APIキーはSCシステム担当者が発行後、ご連絡させて頂きますのでカスタマーポータルからご連絡ください。\n\n ここで発行されるAPIキーは有効期限が無い状態で発行されますので取り扱いにはくれぐれもご注意ください。 不要になったAPIキーは必ず削除してください。 (APIキー漏洩による被害に関しては一切の責任を負いません)\n\n ### APIアクセス方法\n STOCKCREW-APIを提供するエンドポイントは以下のURLになります。\n ```\n https://api.stockcrew.co.jp/ (本番環境)\n https://test.api.stockcrew.co.jp/ (テスト環境)\n\n ```\n \n アクセスする際には指定のリクエストヘッダーを付与する必要があります。\n - X-STOCKCREW-Key：弊社からご連携するAPIキー\n - CompanyCode：貴社の会社コード\n ※本番環境とテスト環境のキーは別のため、利用される際はご注意ください。\n\n ### APIレート上限\n APIリクエストは1分間に約60回を上限とします。\n ※仕様は変更となる場合があります。\n \n ### API共通エラー\n | レスポンスコード | 説明 |\n|----------------------|-------------------------------------|\n| 429 | APIのレート上限に達しました。時間を置いてお試しください。|\n| 401 | 認証エラーです。正しいAPIキーを設定してください。 |\n\n\n ### 会社停止時の共通エラー\n 有効なAPIキーでも会社停止中はHTTP 403とcode: company_suspendedを返します。\n\n ### 会社のサービス停止と利用再開\n 有効なAPIキーの認証後に会社の停止状態を確認し、停止中は参照・登録・更新・削除のすべてを403で拒否します。この応答のリクエストは業務処理を実行せず、保存・キュー化・自動再送もしません。\n 会社単位の停止・解除はSTOCKCREW側で管理します。顧客向けの解除依頼の導線はありません。\n 停止解除後は既存の有効なAPIキーで再開できます。不正・期限切れキーは解除後も401です。UIは再ログインしてください。店舗連携設定・受注保留は自動復元しません。滞留注文の確認と、再送前の処理結果確認を行い、二重出荷を防いでください。\n\n ### システムメンテナンス中のAPI応答\n メンテナンス中は、外部SC-APIの各エンドポイントでHTTP 503（Service Unavailable）を返します。\n この503応答のリクエストは業務処理へ転送されず、登録・更新されません。保存・キュー化や復旧後の自動実行も行いません。\n\n ```http\n HTTP/1.1 503 Service Unavailable\n Content-Type: application/json; charset=utf-8\n Cache-Control: no-store\n Retry-After: 60\n\n {\"message\":\"現在システムメンテナンス中です。終了後に再実行してください。\"}\n ```\n\n Retry-After: 60は、再試行まで少なくとも60秒待つ目安です。60秒後の復旧を保証するものではありません。\n 復旧後、呼び出し元から必要なリクエストを再送してください。終了予定時刻だけではAPIを自動再開しません。\n 開始前に送信した処理のタイムアウト・通信切断では処理結果が不明な場合があります。登録・更新の再送前に結果を確認し、二重処理を防いでください。\n 入口で拒否されたアクセスは、認証・アクセス制限などの既存エラーになる場合があります。HEADの503応答には本文がありません。\n\n",
"license": {
"name": "ISC"
}
},
"paths": {
"/external/item-pos/plan": {
"get": {
"operationId": "入荷予定取得",
"responses": {
"200": {
"description": "Return Item PO List",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ExtItemPOPlanResponseDto"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
{
"itemPONo": "PO123456",
"poTypeCode": "112",
"poTypeName": "Standard Order",
"poStateCode": "CONFIRMED",
"poStateName": "Confirmed",
"itemNo": "ITEM001",
"itemName": "Sample Item",
"poNo": "PO123456",
"lotNo": "LOT001",
"qtyPO": 100,
"qtyPOOrigin": 100,
"datePOEntry": "2023-01-01",
"dateDelivPromise": "2023-01-10",
"dateDelivFinish": "2023-01-15",
"dateExpiration": "2024-01-01",
"supplierCode": "SUP001",
"supplierName": "Sample Supplier",
"supplierNameS": "Sample",
"siteCode": "SITE001",
"siteName": "Main Warehouse",
"shippingPointCode": "100",
"shippingPointName": "Shipping Point 1",
"arrivalTransporterTypeCode": "TRANS001",
"arrivalTransporterTypeName": "Transporter 1",
"arrivalTransInvNo": "INV001",
"whTaskCode": "TASK001",
"whTaskName": "Task 1",
"packingID": "1000123",
"dateShippingDeadline": "2023-01-20",
"qualityOrigin": "A",
"quality": "A",
"qualityReason": "No issues",
"headText10": "Free text 1",
"headText11": "Free text 2",
"headText12": "Free text 3",
"headText13": "Free text 4"
}
]
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "パラメータの条件に合致する入荷予定を取得します",
"tags": [
"入荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "発注番号",
"in": "query",
"name": "itemPONo",
"required": false,
"schema": {
"type": "string",
"maxLength": 7
}
},
{
"description": "商品コード",
"in": "query",
"name": "itemNo",
"required": false,
"schema": {
"type": "string",
"maxLength": 100
}
},
{
"description": "仕入先コード",
"in": "query",
"name": "supplierCode",
"required": false,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"description": "発注登録日（開始）yyyy-MM-dd形式",
"in": "query",
"name": "datePOEntryFrom",
"required": false,
"schema": {
"type": "string",
"maxLength": 10
}
},
{
"description": "発注登録日（終了）yyyy-MM-dd形式",
"in": "query",
"name": "datePOEntryTo",
"required": false,
"schema": {
"type": "string",
"maxLength": 10
}
},
{
"description": "入荷伝票番号",
"in": "query",
"name": "arrivalTransInvNo",
"required": false,
"schema": {
"type": "string",
"maxLength": 300
}
},
{
"description": "発注番号",
"in": "query",
"name": "poNo",
"required": false,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"description": "梱包ID",
"in": "query",
"name": "packingID",
"required": false,
"schema": {
"type": "string",
"maxLength": 7
}
},
{
"description": "page",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"format": "int32",
"type": "integer"
}
},
{
"description": "limit",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 5000,
"format": "int32",
"type": "integer"
}
}
]
}
},
"/external/item-pos/arrival": {
"get": {
"operationId": "入荷実績取得",
"responses": {
"200": {
"description": "Return Arrival Item PO List",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ExtItemPOArrivalResponseDto"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
{
"itemPONo": "PO123456",
"poTypeCode": "112",
"poTypeName": "Standard Order",
"poStateCode": "CONFIRMED",
"poStateName": "Confirmed",
"itemNo": "ITEM001",
"itemName": "Sample Item",
"poNo": "PO123456",
"lotNo": "LOT001",
"qtyPO": 100,
"qtyPOOrigin": 100,
"datePOEntry": "2023-01-01",
"dateDelivPromise": "2023-01-10",
"dateDelivFinish": "2023-01-15",
"dateExpiration": "2024-01-01",
"supplierCode": "SUP001",
"supplierName": "Sample Supplier",
"supplierNameS": "Sample",
"siteCode": "SITE001",
"siteName": "Main Warehouse",
"shippingPointCode": "100",
"shippingPointName": "Shipping Point 1",
"arrivalTransporterTypeCode": "TRANS001",
"arrivalTransporterTypeName": "Transporter 1",
"arrivalTransInvNo": "INV001",
"whTaskCode": "TASK001",
"whTaskName": "Task 1",
"packingID": "1000123",
"dateShippingDeadline": "2023-01-20",
"qualityOrigin": "A",
"quality": "A",
"qualityReason": "No issues",
"headText10": "Free text 1",
"headText11": "Free text 2",
"headText12": "Free text 3",
"headText13": "Free text 4"
}
]
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "パラメータの条件に合致する入荷実績を取得します",
"tags": [
"入荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "発注番号",
"in": "query",
"name": "itemPONo",
"required": false,
"schema": {
"type": "string",
"maxLength": 7
}
},
{
"description": "商品コード",
"in": "query",
"name": "itemNo",
"required": false,
"schema": {
"type": "string",
"maxLength": 100
}
},
{
"description": "仕入先コード",
"in": "query",
"name": "supplierCode",
"required": false,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"description": "入荷実績日（開始）yyyy-MM-dd形式",
"in": "query",
"name": "dateDelivFinishFrom",
"required": false,
"schema": {
"type": "string",
"maxLength": 10
}
},
{
"description": "入荷実績日（終了）yyyy-MM-dd形式",
"in": "query",
"name": "dateDelivFinishTo",
"required": false,
"schema": {
"type": "string",
"maxLength": 10
}
},
{
"description": "入荷伝票番号",
"in": "query",
"name": "arrivalTransInvNo",
"required": false,
"schema": {
"type": "string",
"maxLength": 300
}
},
{
"description": "発注番号",
"in": "query",
"name": "poNo",
"required": false,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"description": "梱包ID",
"in": "query",
"name": "packingID",
"required": false,
"schema": {
"type": "string",
"maxLength": 7
}
},
{
"description": "page",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"format": "int32",
"type": "integer"
}
},
{
"description": "limit",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 5000,
"format": "int32",
"type": "integer"
}
}
]
}
},
"/external/item-pos": {
"post": {
"operationId": "入荷の新規登録",
"responses": {
"201": {
"description": "Created Item PO",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtItemPOResponseDto"
},
"examples": {
"Example 1": {
"value": {
"itemPONo": "PO123456",
"poTypeCode": "112",
"poTypeName": "Standard Order",
"poStateCode": "CONFIRMED",
"poStateName": "Confirmed",
"itemNo": "ITEM001",
"itemName": "Sample Item",
"poNo": "PO123456",
"lotNo": "LOT001",
"qtyPO": 100,
"qtyPOOrigin": 100,
"datePOEntry": "2023-01-01",
"dateDelivPromise": "2023-01-10",
"dateDelivFinish": "2023-01-15",
"dateExpiration": "2024-01-01",
"supplierCode": "SUP001",
"supplierName": "Sample Supplier",
"supplierNameS": "Sample",
"siteCode": "SITE001",
"siteName": "Main Warehouse",
"shippingPointCode": "100",
"shippingPointName": "Shipping Point 1",
"arrivalTransporterTypeCode": "TRANS001",
"arrivalTransporterTypeName": "Transporter 1",
"arrivalTransInvNo": "INV001",
"whTaskCode": "TASK001",
"whTaskName": "Task 1",
"packingID": "1000123",
"dateShippingDeadline": "2023-01-20",
"qualityOrigin": "A",
"quality": "A",
"qualityReason": "No issues",
"headText10": "Free text 1",
"headText11": "Free text 2",
"headText12": "Free text 3",
"headText13": "Free text 4"
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "入荷予定日に、当日および過去の日付は指定出来ません。"
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "入荷予定の登録に失敗しました。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "新規入荷を登録します",
"tags": [
"入荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtCreateItemPODto"
}
}
}
}
}
},
"/external/item-pos/packing/bulk": {
"post": {
"operationId": "箱単位入荷の一括登録",
"responses": {
"201": {
"description": "Created Item PO Packing Bulk",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtCreateItemPOPackingBulkResponseDto"
},
"examples": {
"Example 1": {
"value": {
"datePOEntry": "2026-05-08",
"dateDelivPromise": "2026-05-12",
"arrivalTransporterTypeCode": "900",
"arrivalTransporterTypeName": "その他",
"arrivalTransInvNo": "INV-20260512-001",
"boxes": [
{
"boxNo": 1,
"packingID": "1000123",
"pkgBarcode": "PKG-1234561000123A1B2C3",
"itemPOs": [
{
"lineNo": 1,
"itemPONo": "PO12345",
"itemNo": "ITEM001",
"qtyPO": 10,
"poStateCode": "130",
"poStateName": "入荷待ち"
}
]
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "一括登録できる箱数は最大100件です。現在の箱数: 101件"
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "入力内容に誤りがあります。",
"errors": [
{
"boxNo": 1,
"lineNo": 2,
"itemNo": "ITEM002",
"messages": "指定された品番はマスターに存在しません。"
}
]
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ItemPOCreate_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "入荷予定日に、当日および過去の日付は指定出来ません。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "箱単位の入荷予定を一括登録します\n\n**利用前提**\n\n本APIは、入荷予定登録時に梱包IDをAPI側で採番し、外装ラベルをAPI利用者側で作成・印刷する運用向けのAPIです。\nポータルサイトから外装ラベルを発行する通常運用では使用しないでください。\n本APIで梱包IDを採番した入荷データは、ポータルサイトで外装ラベル作成できません。",
"tags": [
"入荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtCreateItemPOPackingBulkDto"
}
}
}
}
}
},
"/external/item-pos/{itemPONo}": {
"put": {
"operationId": "入荷の更新",
"responses": {
"201": {
"description": "Updated Item PO",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtItemPOResponseDto"
},
"examples": {
"Example 1": {
"value": {
"itemPONo": "PO123456",
"poTypeCode": "112",
"poTypeName": "Standard Order",
"poStateCode": "CONFIRMED",
"poStateName": "Confirmed",
"itemNo": "ITEM001",
"itemName": "Sample Item",
"poNo": "PO123456",
"lotNo": "LOT001",
"qtyPO": 100,
"qtyPOOrigin": 100,
"datePOEntry": "2023-01-01",
"dateDelivPromise": "2023-01-10",
"dateDelivFinish": "2023-01-15",
"dateExpiration": "2024-01-01",
"supplierCode": "SUP001",
"supplierName": "Sample Supplier",
"supplierNameS": "Sample",
"siteCode": "SITE001",
"siteName": "Main Warehouse",
"shippingPointCode": "100",
"shippingPointName": "Shipping Point 1",
"arrivalTransporterTypeCode": "TRANS001",
"arrivalTransporterTypeName": "Transporter 1",
"arrivalTransInvNo": "INV001",
"whTaskCode": "TASK001",
"whTaskName": "Task 1",
"packingID": "1000123",
"dateShippingDeadline": "2023-01-20",
"qualityOrigin": "A",
"quality": "A",
"qualityReason": "No issues",
"headText10": "Free text 1",
"headText11": "Free text 2",
"headText12": "Free text 3",
"headText13": "Free text 4"
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ItemPOUpdate_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "消費期限に、当日および過去の日付は指定出来ません。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "入荷を更新します",
"tags": [
"入荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "入荷ID（PO番号）。",
"in": "path",
"name": "itemPONo",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtUpdateItemPODto"
}
}
}
}
}
},
"/external/item-pos/{itemPONo}/cancel": {
"put": {
"operationId": "入荷の取消",
"responses": {
"201": {
"description": "canceled Item PO No",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Example 1": {
"value": ""
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ItemPOCancel_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "処理できません。 該当データは存在しません。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "入荷をキャンセルします",
"tags": [
"入荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "入荷ID（PO番号）。キャンセルする発注を特定するために使用されます。",
"in": "path",
"name": "itemPONo",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/external/item-pos/packing/{packingID}/release": {
"put": {
"operationId": "梱包IDの解除",
"responses": {
"200": {
"description": "Released Packing ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtReleaseItemPOPackingResponseDto"
},
"examples": {
"Example 1": {
"value": {
"packingID": "1000123",
"released": true,
"itemPONos": [
"PO12345",
"PO12346"
]
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "指定された梱包IDは存在しません。"
}
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "packingIDは7桁の数字で指定してください。"
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "指定された梱包IDに紐づく入荷データは更新できない入荷ステータスです。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "指定した梱包IDの紐付けを解除します",
"tags": [
"入荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"in": "path",
"name": "packingID",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/external/ec-orders/plan": {
"get": {
"operationId": "出荷予定取得",
"responses": {
"200": {
"description": "Return Planned EC Order List",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ExtECOrderResponseDto"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
{
"custShopCode": "SHOP001",
"orderNo": "ORDER001",
"mallOrderNo": "MALL001",
"dateOrder": "2023-10-01",
"datePayment": "2023-10-02",
"dateShip": "2023-10-03",
"orderName": "John Doe",
"orderNameKana": "ジョン ドウ",
"orderZipCode": "123-4567",
"orderPrefName": "Tokyo",
"orderAddress1": "Shibuya",
"orderAddress2": "1-1-1",
"orderAddress3": null,
"orderAddress4": null,
"orderPhone": "090-1234-5678",
"orderFax": null,
"orderEMail": "john.doe@example.com",
"shippingName": "Jane Doe",
"shippingNameKana": "ジェーン ドウ",
"shippingZipCode": "123-4567",
"shippingPrefName": "Tokyo",
"shippingAddress1": "Shibuya",
"shippingAddress2": "1-1-1",
"shippingAddress3": null,
"shippingAddress4": null,
"shippingPhone": "090-1234-5678",
"shippingFax": null,
"transInvNo": "INV001",
"dateDesiredDelivery": "2023-10-04",
"desiredDeliveryName": "Morning",
"desiredDeliveryTime": "10:00-12:00",
"qtyTotal": 2,
"amtPurchaseTotal": 2000,
"amtDiscount": 100,
"amtDiscount_Etc1": null,
"amtDiscount_Etc2": null,
"taxCost": 200,
"amtShippingCharge": 500,
"amtDaibikiCharge": null,
"amtWrappingCharge": null,
"amtSundryCharge": null,
"amtSundryCharge_Etc1": null,
"amtSundryCharge_Etc2": null,
"amtTotal": 2600,
"amtPointUsing": null,
"amtCouponUsing": null,
"amtPaymentTotal": 2600,
"giftFlag": false,
"socialGiftFlag": false,
"wrapping": null,
"noshi": null,
"orderMemo": "Please deliver quickly.",
"orderShopMemo": null,
"custShopName": "Shop Name",
"orderStateName": "Confirmed",
"transporterCode": "1001",
"transporterName": "Yamato",
"deliveryHandoverLocationCode": null,
"deliveryHandoverLocationName": null,
"shippingPointName": "Warehouse A",
"paymentMethod": "Credit Card",
"paymentMethodName": "Visa",
"deliveryTimeName": "Morning",
"siteName": "Main Warehouse",
"shipId": "SHIP001",
"orderCompanyName": null,
"orderCountryName": "Japan",
"shippingCompanyName": null,
"shippingCountryName": "Japan",
"paymentMethodCode": "CC",
"shippingTagDescription": null,
"deliveryTimeCode": "01",
"waitForConfirmFlag": false,
"waitForConfirmReason": null,
"headText10": null,
"headText11": null,
"headText12": null,
"headText13": null,
"headText14": null,
"cntPurchased": 1,
"cntSubscription": 0,
"receiptFlag": false,
"receiptName": null,
"honorific": "Mr.",
"receiptDescription": null,
"amtReceipt": null,
"dateReceipt": null,
"orderOptionNo": null,
"orderErrorFlags": 0,
"lineMemo": null,
"dateCredit": null,
"volumePackingSplitFlag": false,
"shippingTypeCode": "100",
"ecOrderDtl": [
{
"ecItemNo": "ITEM001",
"ecItemName": "Product 1",
"unitPrice": 1000,
"qtyOrder": 1
},
{
"ecItemNo": "ITEM002",
"ecItemName": "Product 2",
"unitPrice": 1000,
"qtyOrder": 1
}
]
}
]
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "パラメータの条件に合致する出荷予定を取得します",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "受注番号",
"in": "query",
"name": "orderNo",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "モール受注番号",
"in": "query",
"name": "mallOrderNo",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderTypeCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderTypeCodeValue"
}
},
{
"description": "【受注ステータスコード（カンマ区切りの複数指定）】
\n100：確認待ち
\n120：入金待ち
\n130：同梱待ち
\n150：引き当て待ち
\n300：出荷待ち
\n400：出荷作業中
",
"in": "query",
"name": "orderStateCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "transporterCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/TransporterCodeValue"
}
},
{
"in": "query",
"name": "paymentMethodCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/PaymentMethodCodeValue"
}
},
{
"description": "お届け先名",
"in": "query",
"name": "shippingName",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "店舗コード",
"in": "query",
"name": "custShopCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "受注日From",
"in": "query",
"name": "dateOrderFrom",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "受注日To",
"in": "query",
"name": "dateOrderTo",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "出荷保留フラグ",
"in": "query",
"name": "waitForConfirmFlag",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "商品コード",
"in": "query",
"name": "ecItemNo",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "出荷管理番号",
"in": "query",
"name": "shipId",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "住所エラーデータのみ表示",
"in": "query",
"name": "isOrderError",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/external/ec-orders/result": {
"get": {
"operationId": "出荷実績取得",
"responses": {
"200": {
"description": "Return EC Order Result List",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ExtECOrderResponseDto"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
{
"custShopCode": "SHOP001",
"orderNo": "ORDER001",
"mallOrderNo": "MALL001",
"dateOrder": "2023-10-01",
"datePayment": "2023-10-02",
"dateShip": "2023-10-03",
"orderName": "John Doe",
"orderNameKana": "ジョン ドウ",
"orderZipCode": "123-4567",
"orderPrefName": "Tokyo",
"orderAddress1": "Shibuya",
"orderAddress2": "1-1-1",
"orderAddress3": null,
"orderAddress4": null,
"orderPhone": "090-1234-5678",
"orderFax": null,
"orderEMail": "john.doe@example.com",
"shippingName": "Jane Doe",
"shippingNameKana": "ジェーン ドウ",
"shippingZipCode": "123-4567",
"shippingPrefName": "Tokyo",
"shippingAddress1": "Shibuya",
"shippingAddress2": "1-1-1",
"shippingAddress3": null,
"shippingAddress4": null,
"shippingPhone": "090-1234-5678",
"shippingFax": null,
"transInvNo": "INV001",
"dateDesiredDelivery": "2023-10-04",
"desiredDeliveryName": "Morning",
"desiredDeliveryTime": "10:00-12:00",
"qtyTotal": 2,
"amtPurchaseTotal": 2000,
"amtDiscount": 100,
"amtDiscount_Etc1": null,
"amtDiscount_Etc2": null,
"taxCost": 200,
"amtShippingCharge": 500,
"amtDaibikiCharge": null,
"amtWrappingCharge": null,
"amtSundryCharge": null,
"amtSundryCharge_Etc1": null,
"amtSundryCharge_Etc2": null,
"amtTotal": 2600,
"amtPointUsing": null,
"amtCouponUsing": null,
"amtPaymentTotal": 2600,
"giftFlag": false,
"socialGiftFlag": false,
"wrapping": null,
"noshi": null,
"orderMemo": "Please deliver quickly.",
"orderShopMemo": null,
"custShopName": "Shop Name",
"orderStateName": "Confirmed",
"transporterCode": "1001",
"transporterName": "Yamato",
"deliveryHandoverLocationCode": null,
"deliveryHandoverLocationName": null,
"shippingPointName": "Warehouse A",
"paymentMethod": "Credit Card",
"paymentMethodName": "Visa",
"deliveryTimeName": "Morning",
"siteName": "Main Warehouse",
"shipId": "SHIP001",
"orderCompanyName": null,
"orderCountryName": "Japan",
"shippingCompanyName": null,
"shippingCountryName": "Japan",
"paymentMethodCode": "CC",
"shippingTagDescription": null,
"deliveryTimeCode": "01",
"waitForConfirmFlag": false,
"waitForConfirmReason": null,
"headText10": null,
"headText11": null,
"headText12": null,
"headText13": null,
"headText14": null,
"cntPurchased": 1,
"cntSubscription": 0,
"receiptFlag": false,
"receiptName": null,
"honorific": "Mr.",
"receiptDescription": null,
"amtReceipt": null,
"dateReceipt": null,
"orderOptionNo": null,
"orderErrorFlags": 0,
"lineMemo": null,
"dateCredit": null,
"volumePackingSplitFlag": false,
"shippingTypeCode": "100",
"ecOrderDtl": [
{
"ecItemNo": "ITEM001",
"ecItemName": "Product 1",
"unitPrice": 1000,
"qtyOrder": 1
},
{
"ecItemNo": "ITEM002",
"ecItemName": "Product 2",
"unitPrice": 1000,
"qtyOrder": 1
}
]
}
]
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "パラメータの条件に合致する出荷実績を取得します",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "受注番号",
"in": "query",
"name": "orderNo",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "モール受注番号",
"in": "query",
"name": "mallOrderNo",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderTypeCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderTypeCodeValue"
}
},
{
"in": "query",
"name": "transporterCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/TransporterCodeValue"
}
},
{
"in": "query",
"name": "paymentMethodCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/PaymentMethodCodeValue"
}
},
{
"description": "お届け先名",
"in": "query",
"name": "shippingName",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "店舗コード",
"in": "query",
"name": "custShopCode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "受注日From",
"in": "query",
"name": "dateOrderFrom",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "受注日To",
"in": "query",
"name": "dateOrderTo",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "出荷日From",
"in": "query",
"name": "dateShipFrom",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "出荷日To",
"in": "query",
"name": "dateShipTo",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "出荷保留フラグ",
"in": "query",
"name": "waitForConfirmFlag",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "商品コード",
"in": "query",
"name": "ecItemNo",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "出荷管理番号",
"in": "query",
"name": "shipId",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "住所エラーデータのみ表示",
"in": "query",
"name": "isOrderError",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/external/ec-orders/packing": {
"get": {
"operationId": "梱包情報取得",
"responses": {
"200": {
"description": "Return EC Order Packing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtECOrderPackingResponseDto"
},
"examples": {
"Example 1": {
"value": {
"custShopCode": "SHOP001",
"orderNo": "ORDER001",
"shipId": "1012031000430",
"shippingTypeCode": "110",
"volumePackingSplitFlag": true,
"packingStatus": "REGISTERED",
"packingDataType": "ACTUAL",
"seqCount": 2,
"isSplit": true,
"boxes": [
{
"seqNo": 1,
"boxShipId": "1012031000430-1",
"cartonSize": "140",
"cartonDimensions": {
"width": 0.59,
"depth": 0.38,
"height": 0.33,
"unit": "m",
"source": "CARTON_SIZE_MASTER"
},
"weight": {
"value": 18.42,
"unit": "kg",
"source": "HANDY_INSPECTION"
},
"items": [
{
"ecItemNo": "ITEM-001",
"ecItemName": "商品名",
"qty": 12
}
]
}
]
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "指定された注文が存在しません。"
}
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "梱包情報は出荷作業中以降の注文で取得できます。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "パラメータの条件に合致する梱包情報を取得します",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "店舗コード",
"in": "query",
"name": "custShopCode",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"description": "注文番号",
"in": "query",
"name": "orderNo",
"required": true,
"schema": {
"type": "string",
"maxLength": 50
}
},
{
"description": "箱No",
"in": "query",
"name": "seqNo",
"required": false,
"schema": {
"format": "double",
"type": "number"
}
}
]
}
},
"/external/ec-orders/to-c-order": {
"post": {
"operationId": "新規受注登録",
"responses": {
"201": {
"description": "Created EC Order",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtECOrderResponseDto"
},
"examples": {
"Example 1": {
"value": {
"custShopCode": "SHOP001",
"orderNo": "ORDER001",
"mallOrderNo": "MALL001",
"dateOrder": "2023-10-01",
"datePayment": "2023-10-02",
"dateShip": "2023-10-03",
"orderName": "John Doe",
"orderNameKana": "ジョン ドウ",
"orderZipCode": "123-4567",
"orderPrefName": "Tokyo",
"orderAddress1": "Shibuya",
"orderAddress2": "1-1-1",
"orderAddress3": null,
"orderAddress4": null,
"orderPhone": "090-1234-5678",
"orderFax": null,
"orderEMail": "john.doe@example.com",
"shippingName": "Jane Doe",
"shippingNameKana": "ジェーン ドウ",
"shippingZipCode": "123-4567",
"shippingPrefName": "Tokyo",
"shippingAddress1": "Shibuya",
"shippingAddress2": "1-1-1",
"shippingAddress3": null,
"shippingAddress4": null,
"shippingPhone": "090-1234-5678",
"shippingFax": null,
"transInvNo": "INV001",
"dateDesiredDelivery": "2023-10-04",
"desiredDeliveryName": "Morning",
"desiredDeliveryTime": "10:00-12:00",
"qtyTotal": 2,
"amtPurchaseTotal": 2000,
"amtDiscount": 100,
"amtDiscount_Etc1": null,
"amtDiscount_Etc2": null,
"taxCost": 200,
"amtShippingCharge": 500,
"amtDaibikiCharge": null,
"amtWrappingCharge": null,
"amtSundryCharge": null,
"amtSundryCharge_Etc1": null,
"amtSundryCharge_Etc2": null,
"amtTotal": 2600,
"amtPointUsing": null,
"amtCouponUsing": null,
"amtPaymentTotal": 2600,
"giftFlag": false,
"socialGiftFlag": false,
"wrapping": null,
"noshi": null,
"orderMemo": "Please deliver quickly.",
"orderShopMemo": null,
"custShopName": "Shop Name",
"orderStateName": "Confirmed",
"transporterCode": "1001",
"transporterName": "Yamato",
"deliveryHandoverLocationCode": null,
"deliveryHandoverLocationName": null,
"shippingPointName": "Warehouse A",
"paymentMethod": "Credit Card",
"paymentMethodName": "Visa",
"deliveryTimeName": "Morning",
"siteName": "Main Warehouse",
"shipId": "SHIP001",
"orderCompanyName": null,
"orderCountryName": "Japan",
"shippingCompanyName": null,
"shippingCountryName": "Japan",
"paymentMethodCode": "CC",
"shippingTagDescription": null,
"deliveryTimeCode": "01",
"waitForConfirmFlag": false,
"waitForConfirmReason": null,
"headText10": null,
"headText11": null,
"headText12": null,
"headText13": null,
"headText14": null,
"cntPurchased": 1,
"cntSubscription": 0,
"receiptFlag": false,
"receiptName": null,
"honorific": "Mr.",
"receiptDescription": null,
"amtReceipt": null,
"dateReceipt": null,
"orderOptionNo": null,
"orderErrorFlags": 0,
"lineMemo": null,
"dateCredit": null,
"volumePackingSplitFlag": false,
"shippingTypeCode": "100",
"ecOrderDtl": [
{
"ecItemNo": "ITEM001",
"ecItemName": "Product 1",
"unitPrice": 1000,
"qtyOrder": 1
},
{
"ecItemNo": "ITEM002",
"ecItemName": "Product 2",
"unitPrice": 1000,
"qtyOrder": 1
}
]
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ECOrderCreateToC_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "お届け希望時間帯の入力が正しくありません。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "新規受注を登録します",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtCreateToCOrderDto"
}
}
}
}
}
},
"/external/ec-orders/bulk-to-c-order": {
"post": {
"operationId": "新規受注一括登録",
"responses": {
"201": {
"description": "Created EC Orders",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ExtECOrderResponseDto"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
{
"custShopCode": "SHOP001",
"orderNo": "ORDER001",
"mallOrderNo": "MALL001",
"dateOrder": "2023-10-01",
"datePayment": "2023-10-02",
"dateShip": "2023-10-03",
"orderName": "John Doe",
"orderNameKana": "ジョン ドウ",
"orderZipCode": "123-4567",
"orderPrefName": "Tokyo",
"orderAddress1": "Shibuya",
"orderAddress2": "1-1-1",
"orderAddress3": null,
"orderAddress4": null,
"orderPhone": "090-1234-5678",
"orderFax": null,
"orderEMail": "john.doe@example.com",
"shippingName": "Jane Doe",
"shippingNameKana": "ジェーン ドウ",
"shippingZipCode": "123-4567",
"shippingPrefName": "Tokyo",
"shippingAddress1": "Shibuya",
"shippingAddress2": "1-1-1",
"shippingAddress3": null,
"shippingAddress4": null,
"shippingPhone": "090-1234-5678",
"shippingFax": null,
"transInvNo": "INV001",
"dateDesiredDelivery": "2023-10-04",
"desiredDeliveryName": "Morning",
"desiredDeliveryTime": "10:00-12:00",
"qtyTotal": 2,
"amtPurchaseTotal": 2000,
"amtDiscount": 100,
"amtDiscount_Etc1": null,
"amtDiscount_Etc2": null,
"taxCost": 200,
"amtShippingCharge": 500,
"amtDaibikiCharge": null,
"amtWrappingCharge": null,
"amtSundryCharge": null,
"amtSundryCharge_Etc1": null,
"amtSundryCharge_Etc2": null,
"amtTotal": 2600,
"amtPointUsing": null,
"amtCouponUsing": null,
"amtPaymentTotal": 2600,
"giftFlag": false,
"socialGiftFlag": false,
"wrapping": null,
"noshi": null,
"orderMemo": "Please deliver quickly.",
"orderShopMemo": null,
"custShopName": "Shop Name",
"orderStateName": "Confirmed",
"transporterCode": "1001",
"transporterName": "Yamato",
"deliveryHandoverLocationCode": null,
"deliveryHandoverLocationName": null,
"shippingPointName": "Warehouse A",
"paymentMethod": "Credit Card",
"paymentMethodName": "Visa",
"deliveryTimeName": "Morning",
"siteName": "Main Warehouse",
"shipId": "SHIP001",
"orderCompanyName": null,
"orderCountryName": "Japan",
"shippingCompanyName": null,
"shippingCountryName": "Japan",
"paymentMethodCode": "CC",
"shippingTagDescription": null,
"deliveryTimeCode": "01",
"waitForConfirmFlag": false,
"waitForConfirmReason": null,
"headText10": null,
"headText11": null,
"headText12": null,
"headText13": null,
"headText14": null,
"cntPurchased": 1,
"cntSubscription": 0,
"receiptFlag": false,
"receiptName": null,
"honorific": "Mr.",
"receiptDescription": null,
"amtReceipt": null,
"dateReceipt": null,
"orderOptionNo": null,
"orderErrorFlags": 0,
"lineMemo": null,
"dateCredit": null,
"volumePackingSplitFlag": false,
"shippingTypeCode": "100",
"ecOrderDtl": [
{
"ecItemNo": "ITEM001",
"ecItemName": "Product 1",
"unitPrice": 1000,
"qtyOrder": 1
},
{
"ecItemNo": "ITEM002",
"ecItemName": "Product 2",
"unitPrice": 1000,
"qtyOrder": 1
}
]
},
{
"custShopCode": "SHOP002",
"orderNo": "ORDER002",
"mallOrderNo": "MALL002",
"dateOrder": "2023-10-05",
"datePayment": "2023-10-06",
"dateShip": "2023-10-07",
"orderName": "Alice Smith",
"orderNameKana": "アリス スミス",
"orderZipCode": "234-5678",
"orderPrefName": "Osaka",
"orderAddress1": "Namba",
"orderAddress2": "2-2-2",
"orderAddress3": null,
"orderAddress4": null,
"orderPhone": "080-9876-5432",
"orderFax": null,
"orderEMail": "alice.smith@example.com",
"shippingName": "Bob Smith",
"shippingNameKana": "ボブ スミス",
"shippingZipCode": "234-5678",
"shippingPrefName": "Osaka",
"shippingAddress1": "Namba",
"shippingAddress2": "2-2-2",
"shippingAddress3": null,
"shippingAddress4": null,
"shippingPhone": "080-9876-5432",
"shippingFax": null,
"transInvNo": "INV002",
"dateDesiredDelivery": "2023-10-08",
"desiredDeliveryName": "Afternoon",
"desiredDeliveryTime": "14:00-16:00",
"qtyTotal": 1,
"amtPurchaseTotal": 3000,
"amtDiscount": 200,
"amtDiscount_Etc1": null,
"amtDiscount_Etc2": null,
"taxCost": 300,
"amtShippingCharge": 700,
"amtDaibikiCharge": null,
"amtWrappingCharge": null,
"amtSundryCharge": null,
"amtSundryCharge_Etc1": null,
"amtSundryCharge_Etc2": null,
"amtTotal": 3800,
"amtPointUsing": null,
"amtCouponUsing": null,
"amtPaymentTotal": 3800,
"giftFlag": true,
"socialGiftFlag": false,
"wrapping": "Gift Wrap",
"noshi": "Happy Birthday",
"orderMemo": "Gift for a friend.",
"orderShopMemo": null,
"custShopName": "Osaka Shop",
"orderStateName": "Processing",
"transporterCode": "2001",
"transporterName": "Sagawa",
"deliveryHandoverLocationCode": null,
"deliveryHandoverLocationName": null,
"shippingPointName": "Warehouse B",
"paymentMethod": "PayPal",
"paymentMethodName": "PayPal",
"deliveryTimeName": "Afternoon",
"siteName": "Osaka Warehouse",
"shipId": "SHIP002",
"orderCompanyName": null,
"orderCountryName": "Japan",
"shippingCompanyName": null,
"shippingCountryName": "Japan",
"paymentMethodCode": "PP",
"shippingTagDescription": null,
"deliveryTimeCode": "02",
"waitForConfirmFlag": false,
"waitForConfirmReason": null,
"headText10": null,
"headText11": null,
"headText12": null,
"headText13": null,
"headText14": null,
"cntPurchased": 1,
"cntSubscription": 0,
"receiptFlag": false,
"receiptName": null,
"honorific": "Ms.",
"receiptDescription": null,
"amtReceipt": null,
"dateReceipt": null,
"orderOptionNo": null,
"orderErrorFlags": 0,
"lineMemo": null,
"dateCredit": null,
"volumePackingSplitFlag": false,
"shippingTypeCode": "100",
"ecOrderDtl": [
{
"ecItemNo": "ITEM003",
"ecItemName": "Product 3",
"unitPrice": 3000,
"qtyOrder": 1
}
]
}
]
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ECOrderCreateToC_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "一括登録できる注文数は最大100件です。現在の件数: 1000件"
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "Validation failed",
"errors": [
{
"custShopCode": "1000",
"orderNo": "orderNo-1",
"messages": "明細1: 指定された品番（itemNo）はマスターに存在しません。"
}
]
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ECOrderCreateToC_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "お届け希望時間帯の入力が正しくありません。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "複数の新規受注を一括登録します(最大100件)",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ExtCreateToCOrderDto"
},
"type": "array"
}
}
}
}
}
},
"/external/ec-orders/to-b-order": {
"post": {
"operationId": "新規出荷登録",
"responses": {
"201": {
"description": "Created EC Order",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtECOrderResponseDto"
},
"examples": {
"Example 1": {
"value": {
"custShopCode": "SHOP001",
"orderNo": "ORDER001",
"mallOrderNo": "MALL001",
"dateOrder": "2023-10-01",
"datePayment": "2023-10-02",
"dateShip": "2023-10-03",
"orderName": "John Doe",
"orderNameKana": "ジョン ドウ",
"orderZipCode": "123-4567",
"orderPrefName": "Tokyo",
"orderAddress1": "Shibuya",
"orderAddress2": "1-1-1",
"orderAddress3": null,
"orderAddress4": null,
"orderPhone": "090-1234-5678",
"orderFax": null,
"orderEMail": "john.doe@example.com",
"shippingName": "Jane Doe",
"shippingNameKana": "ジェーン ドウ",
"shippingZipCode": "123-4567",
"shippingPrefName": "Tokyo",
"shippingAddress1": "Shibuya",
"shippingAddress2": "1-1-1",
"shippingAddress3": null,
"shippingAddress4": null,
"shippingPhone": "090-1234-5678",
"shippingFax": null,
"transInvNo": "INV001",
"dateDesiredDelivery": "2023-10-04",
"desiredDeliveryName": "Morning",
"desiredDeliveryTime": "10:00-12:00",
"qtyTotal": 2,
"amtPurchaseTotal": 2000,
"amtDiscount": 100,
"amtDiscount_Etc1": null,
"amtDiscount_Etc2": null,
"taxCost": 200,
"amtShippingCharge": 500,
"amtDaibikiCharge": null,
"amtWrappingCharge": null,
"amtSundryCharge": null,
"amtSundryCharge_Etc1": null,
"amtSundryCharge_Etc2": null,
"amtTotal": 2600,
"amtPointUsing": null,
"amtCouponUsing": null,
"amtPaymentTotal": 2600,
"giftFlag": false,
"socialGiftFlag": false,
"wrapping": null,
"noshi": null,
"orderMemo": "Please deliver quickly.",
"orderShopMemo": null,
"custShopName": "Shop Name",
"orderStateName": "Confirmed",
"transporterCode": "1001",
"transporterName": "Yamato",
"deliveryHandoverLocationCode": null,
"deliveryHandoverLocationName": null,
"shippingPointName": "Warehouse A",
"paymentMethod": "Credit Card",
"paymentMethodName": "Visa",
"deliveryTimeName": "Morning",
"siteName": "Main Warehouse",
"shipId": "SHIP001",
"orderCompanyName": null,
"orderCountryName": "Japan",
"shippingCompanyName": null,
"shippingCountryName": "Japan",
"paymentMethodCode": "CC",
"shippingTagDescription": null,
"deliveryTimeCode": "01",
"waitForConfirmFlag": false,
"waitForConfirmReason": null,
"headText10": null,
"headText11": null,
"headText12": null,
"headText13": null,
"headText14": null,
"cntPurchased": 1,
"cntSubscription": 0,
"receiptFlag": false,
"receiptName": null,
"honorific": "Mr.",
"receiptDescription": null,
"amtReceipt": null,
"dateReceipt": null,
"orderOptionNo": null,
"orderErrorFlags": 0,
"lineMemo": null,
"dateCredit": null,
"volumePackingSplitFlag": false,
"shippingTypeCode": "100",
"ecOrderDtl": [
{
"ecItemNo": "ITEM001",
"ecItemName": "Product 1",
"unitPrice": 1000,
"qtyOrder": 1
},
{
"ecItemNo": "ITEM002",
"ecItemName": "Product 2",
"unitPrice": 1000,
"qtyOrder": 1
}
]
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ECOrderCreateToB_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "お届け希望時間帯の入力が正しくありません。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "新規出荷を登録します",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtCreateToBOrderDto"
}
}
}
}
}
},
"/external/ec-orders/fba-label-files": {
"put": {
"operationId": "FBAラベルPDF URL登録",
"responses": {
"200": {
"description": "Updated FBA Label Files",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtSaveFbaLabelFilesResponseDto"
},
"examples": {
"Example 1": {
"value": {
"custShopCode": "SHOP001",
"orderNo": "ORDER001",
"updatedFiles": [
{
"fileNo": 1,
"fbaLabelNo": "FBAxxxxxxxxx",
"fileUrl": "https://storage.example.com/fba-label-files/SHOP001/ORDER001/1.pdf",
"originalFileName": "FBA_LABEL_ORDER001.pdf"
}
]
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "指定された注文が存在しません。"
}
}
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"examples": {
"Example 1": {
"value": {
"message": "FBAラベルPDFはFBA出荷の注文のみ登録できます。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "FBAラベルPDF URLを登録します",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtSaveFbaLabelFilesDto"
}
}
}
}
}
},
"/external/ec-orders/{custShopCode}": {
"put": {
"operationId": "出荷の更新",
"responses": {
"201": {
"description": "Updated EC Order",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtECOrderResponseDto"
},
"examples": {
"Example 1": {
"value": {
"custShopCode": "SHOP001",
"orderNo": "ORDER001",
"mallOrderNo": "MALL001",
"dateOrder": "2023-10-01",
"datePayment": "2023-10-02",
"dateShip": "2023-10-03",
"orderName": "John Doe",
"orderNameKana": "ジョン ドウ",
"orderZipCode": "123-4567",
"orderPrefName": "Tokyo",
"orderAddress1": "Shibuya",
"orderAddress2": "1-1-1",
"orderAddress3": null,
"orderAddress4": null,
"orderPhone": "090-1234-5678",
"orderFax": null,
"orderEMail": "john.doe@example.com",
"shippingName": "Jane Doe",
"shippingNameKana": "ジェーン ドウ",
"shippingZipCode": "123-4567",
"shippingPrefName": "Tokyo",
"shippingAddress1": "Shibuya",
"shippingAddress2": "1-1-1",
"shippingAddress3": null,
"shippingAddress4": null,
"shippingPhone": "090-1234-5678",
"shippingFax": null,
"transInvNo": "INV001",
"dateDesiredDelivery": "2023-10-04",
"desiredDeliveryName": "Morning",
"desiredDeliveryTime": "10:00-12:00",
"qtyTotal": 2,
"amtPurchaseTotal": 2000,
"amtDiscount": 100,
"amtDiscount_Etc1": null,
"amtDiscount_Etc2": null,
"taxCost": 200,
"amtShippingCharge": 500,
"amtDaibikiCharge": null,
"amtWrappingCharge": null,
"amtSundryCharge": null,
"amtSundryCharge_Etc1": null,
"amtSundryCharge_Etc2": null,
"amtTotal": 2600,
"amtPointUsing": null,
"amtCouponUsing": null,
"amtPaymentTotal": 2600,
"giftFlag": false,
"socialGiftFlag": false,
"wrapping": null,
"noshi": null,
"orderMemo": "Please deliver quickly.",
"orderShopMemo": null,
"custShopName": "Shop Name",
"orderStateName": "Confirmed",
"transporterCode": "1001",
"transporterName": "Yamato",
"deliveryHandoverLocationCode": null,
"deliveryHandoverLocationName": null,
"shippingPointName": "Warehouse A",
"paymentMethod": "Credit Card",
"paymentMethodName": "Visa",
"deliveryTimeName": "Morning",
"siteName": "Main Warehouse",
"shipId": "SHIP001",
"orderCompanyName": null,
"orderCountryName": "Japan",
"shippingCompanyName": null,
"shippingCountryName": "Japan",
"paymentMethodCode": "CC",
"shippingTagDescription": null,
"deliveryTimeCode": "01",
"waitForConfirmFlag": false,
"waitForConfirmReason": null,
"headText10": null,
"headText11": null,
"headText12": null,
"headText13": null,
"headText14": null,
"cntPurchased": 1,
"cntSubscription": 0,
"receiptFlag": false,
"receiptName": null,
"honorific": "Mr.",
"receiptDescription": null,
"amtReceipt": null,
"dateReceipt": null,
"orderOptionNo": null,
"orderErrorFlags": 0,
"lineMemo": null,
"dateCredit": null,
"volumePackingSplitFlag": false,
"shippingTypeCode": "100",
"ecOrderDtl": [
{
"ecItemNo": "ITEM001",
"ecItemName": "Product 1",
"unitPrice": 1000,
"qtyOrder": 1
},
{
"ecItemNo": "ITEM002",
"ecItemName": "Product 2",
"unitPrice": 1000,
"qtyOrder": 1
}
]
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ECOrderUpdate_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "お届け先氏名は必須です。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "出荷を更新します",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "店舗コード",
"in": "path",
"name": "custShopCode",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtUpdateECOrderDto"
}
}
}
}
}
},
"/external/ec-orders/{custShopCode}/cancel": {
"put": {
"operationId": "出荷の取消",
"responses": {
"201": {
"description": "canceled EC Order",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Example 1": {
"value": ""
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSP_ECOrderCancel"
},
"examples": {
"Example 1": {
"value": {
"message": "処理できません。 該当受注データーは出荷済み以前のデータに存在しません。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "ECオーダーキャンセルします",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "店舗コード",
"in": "path",
"name": "custShopCode",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtCancelECOrderDto"
}
}
}
}
}
},
"/external/ec-orders/{custShopCode}/ec-cancel": {
"put": {
"operationId": "ECサイトキャンセル反映",
"responses": {
"200": {
"description": "Reflected EC-site cancellation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtReflectEcCancellationResponseDto"
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "ECサイト側（EC購入者）のキャンセル検知をSTOCKCREWへ反映し、該当出荷を止めます。\n\n楽天など各モールへの取消実行は行いません。検知・認証・SC受注の突合はAPISync側で行い、本APIは単一受注を受け取ります。\n受注の進捗に応じて自動で振り分けます。\n- 出荷待ち以前: 削除せず「ECサイト側キャンセルのため」の理由付きで保留します（他の保留理由は上書きしません）。\n- 出荷作業中以降: 出荷キャンセル依頼を登録します（倉庫のJ40出荷キャンセルで完了します）。\n再検知時は反映済み（already_processed）として冪等に扱い、手動解除を尊重して再適用しません。\n出荷済み・取消済み・該当なしは対象外（skipped）です。",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "店舗コード",
"in": "path",
"name": "custShopCode",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtCancelECOrderDto"
}
}
}
}
}
},
"/external/ec-orders/deliv-slip/{custShopCode}/{orderNo}": {
"get": {
"operationId": "納品書ダウンロード",
"responses": {
"200": {
"description": "Download Delivery Slip"
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfDelivSlipNotFound"
},
"examples": {
"Example 1": {
"value": {
"message": "該当する納品書が見つかりませんでした。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "納品書をダウンロードします",
"tags": [
"出荷"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "店舗コード",
"in": "path",
"name": "custShopCode",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "注文番号",
"in": "path",
"name": "orderNo",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/external/inventories": {
"get": {
"operationId": "在庫取得",
"responses": {
"200": {
"description": "Return Inventory List",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ExtInventoryResponseDto"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
{
"gtinCode": "1234567890123",
"itemNo": "ITEM001",
"itemName": "Sample Item",
"dateExpiration": "2023-12-31",
"dateShippingDeadline": "2023-11-30",
"dateStockUpdate": "2023-11-01",
"qtyArrival": 100,
"qtyStock": 200,
"qtyStockFree": 150,
"qtySalesStock": 148,
"qtyAllocateAll": 50,
"qtyWaitAllocate": 30,
"qtyShipping": 20,
"shippingPointCode": "100",
"shippingPointName": "YashioDock",
"siteCode": "1000",
"siteName": "Main Warehouse",
"itemTypeName": "Product",
"unitRetailPrice": 1000,
"unitCostPrice": 800,
"itemGroupName": "Electronics",
"threeM": 150
}
]
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "パラメータの条件に合致する在庫情報を取得します",
"tags": [
"在庫"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "商品コード",
"in": "query",
"name": "itemNo",
"required": false,
"schema": {
"type": "string",
"maxLength": 100
}
},
{
"description": "物流ID",
"in": "query",
"name": "gtinCode",
"required": false,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"in": "query",
"name": "siteCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/SiteCodeValue"
}
},
{
"in": "query",
"name": "itemTypeCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/ItemTypeCodeValue"
}
},
{
"description": "出荷締切日（開始）",
"in": "query",
"name": "dateShippingDeadlineFrom",
"required": false,
"schema": {
"type": "string",
"maxLength": 10
}
},
{
"description": "出荷締切日（終了）",
"in": "query",
"name": "dateShippingDeadlineTo",
"required": false,
"schema": {
"type": "string",
"maxLength": 10
}
},
{
"description": "在庫数変動日\n指定日の0時（JST）以降に在庫数が変動した商品だけを返却します。",
"in": "query",
"name": "dateStockUpdateFrom",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "入荷待ち在庫を表示するかどうか",
"in": "query",
"name": "showArrivalFlag",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
},
{
"description": "在庫数ゼロの商品も表示するかどうか",
"in": "query",
"name": "showQtyZeroFlag",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
},
{
"description": "欠品在庫を表示するかどうか。",
"in": "query",
"name": "showQtyWaitAllocate",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
}
]
}
},
"/external/items": {
"get": {
"operationId": "商品取得",
"responses": {
"200": {
"description": "Return Item List",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ExtItemResponseDto"
},
"type": "array"
},
"examples": {
"Example 1": {
"value": [
{
"gtinCode": "1234567890123",
"itemNo": "ITEM001",
"itemName": "Sample Item",
"itemGroupCode": "12",
"supplierCode": "SUP001",
"unitRetailPrice": 1000,
"unitCostPrice": 800,
"salesPageURL": "http://example.com/item001",
"sizeW": 10,
"sizeH": 20,
"sizeD": 30,
"weight": 500,
"shippingTagContentsName": "Sample Contents",
"itemMemo": "Sample memo",
"itemGroupName": "Sample Group",
"supplierName": "Sample Supplier",
"transporterName": "Sample Transporter",
"setItemFlag": false,
"itemTypeCode": "100",
"itemTypeName": "Sample Type",
"setItemNo": null,
"qtyInSet": null,
"qtyPOPoint": 50,
"qtyPOLot": 100,
"qtySalesBuffer": 0,
"foreignItemFlag": false,
"hSCode": "HS1234",
"productHSDescription1": "Sample Description 1",
"productHSDescription2": "Sample Description 2",
"originCountryCode": "JP",
"idManageFlag": true,
"caseShippingFlag": false,
"foldNekoposFlag": false,
"checkDateExpirationFlag": true,
"daysBeforeShippingDeadline": 30,
"setItemDtl": []
}
]
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "パラメータの条件に合致する商品を取得します",
"tags": [
"商品"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "商品コード",
"in": "query",
"name": "itemNo",
"required": false,
"schema": {
"default": "",
"type": "string",
"maxLength": 100
}
},
{
"description": "商品名",
"in": "query",
"name": "itemName",
"required": false,
"schema": {
"default": "",
"type": "string",
"maxLength": 300
}
},
{
"description": "仕入先コード",
"in": "query",
"name": "supplierCode",
"required": false,
"schema": {
"default": "100",
"type": "string",
"maxLength": 20
}
},
{
"description": "物流ID",
"in": "query",
"name": "gtinCode",
"required": false,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"in": "query",
"name": "itemTypeCode",
"required": false,
"schema": {
"$ref": "#/components/schemas/ItemTypeCodeValue"
}
},
{
"description": "セット商品のみ表示する",
"in": "query",
"name": "setItemFlag",
"required": false,
"schema": {
"type": "boolean"
}
}
]
},
"post": {
"operationId": "新規商品登録",
"responses": {
"201": {
"description": "Created Item",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtItemResponseDto"
},
"examples": {
"Example 1": {
"value": {
"gtinCode": "1234567890123",
"itemNo": "ITEM001",
"itemName": "Sample Item",
"itemGroupCode": "12",
"supplierCode": "SUP001",
"unitRetailPrice": 1000,
"unitCostPrice": 800,
"salesPageURL": "http://example.com/item001",
"sizeW": 10,
"sizeH": 20,
"sizeD": 30,
"weight": 500,
"shippingTagContentsName": "Sample Contents",
"itemMemo": "Sample memo",
"itemGroupName": "Sample Group",
"supplierName": "Sample Supplier",
"transporterName": "Sample Transporter",
"setItemFlag": false,
"itemTypeCode": "100",
"itemTypeName": "Sample Type",
"setItemNo": null,
"qtyInSet": null,
"qtyPOPoint": 50,
"qtyPOLot": 100,
"qtySalesBuffer": 0,
"foreignItemFlag": false,
"hSCode": "HS1234",
"productHSDescription1": "Sample Description 1",
"productHSDescription2": "Sample Description 2",
"originCountryCode": "JP",
"idManageFlag": true,
"caseShippingFlag": false,
"foldNekoposFlag": false,
"checkDateExpirationFlag": true,
"daysBeforeShippingDeadline": 30,
"setItemDtl": []
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "新規商品を登録します",
"tags": [
"商品"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtCreateItemDto"
}
}
}
}
}
},
"/external/items/{itemNo}": {
"put": {
"operationId": "商品の更新",
"responses": {
"201": {
"description": "Updated Item",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtItemResponseDto"
},
"examples": {
"Example 1": {
"value": {
"gtinCode": "1234567890123",
"itemNo": "ITEM001",
"itemName": "Sample Item",
"itemGroupCode": "12",
"supplierCode": "SUP001",
"unitRetailPrice": 1000,
"unitCostPrice": 800,
"salesPageURL": "http://example.com/item001",
"sizeW": 10,
"sizeH": 20,
"sizeD": 30,
"weight": 500,
"shippingTagContentsName": "Sample Contents",
"itemMemo": "Sample memo",
"itemGroupName": "Sample Group",
"supplierName": "Sample Supplier",
"transporterName": "Sample Transporter",
"setItemFlag": false,
"itemTypeCode": "100",
"itemTypeName": "Sample Type",
"setItemNo": null,
"qtyInSet": null,
"qtyPOPoint": 50,
"qtyPOLot": 100,
"qtySalesBuffer": 0,
"foreignItemFlag": false,
"hSCode": "HS1234",
"productHSDescription1": "Sample Description 1",
"productHSDescription2": "Sample Description 2",
"originCountryCode": "JP",
"idManageFlag": true,
"caseShippingFlag": false,
"foldNekoposFlag": false,
"checkDateExpirationFlag": true,
"daysBeforeShippingDeadline": 30,
"setItemDtl": []
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ItemMasterUpdate_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "構成商品の商品コードは必須です。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "商品を更新します",
"tags": [
"商品"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "商品コード",
"in": "path",
"name": "itemNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtUpdateItemDto"
}
}
}
}
}
},
"/external/items/{itemNo}/cancel": {
"put": {
"operationId": "商品の取消",
"responses": {
"201": {
"description": "cancel item",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"examples": {
"Example 1": {
"value": ""
}
}
}
}
},
"403": {
"$ref": "#/components/responses/CompanySuspended"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessageOfSA_ItemMasterCancel_ForAPI"
},
"examples": {
"Example 1": {
"value": {
"message": "処理できません。 該当データは存在しません。"
}
}
}
}
}
},
"503": {
"$ref": "#/components/responses/SystemMaintenance"
}
},
"description": "商品を取消します",
"tags": [
"商品"
],
"security": [
{
"EXTERNAL_API": []
}
],
"parameters": [
{
"description": "商品コード",
"in": "path",
"name": "itemNo",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"servers": [
{
"url": "https://api.stockcrew.co.jp/api"
}
]
}