すべての品目詳細の取得
get
/fscmRestApi/resources/11.13.18.05/shoppingCatalogItemDetails
リクエスト
問合せパラメータ
- expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- FindById : 検索オブジェクト識別子およびユーザー・プリファレンス識別子に従って、カタログ品目詳細を検索します。
ファインダ変数:- SearchObjectId; integer; カタログ品目によって参照される検索オブジェクトを一意に識別する値。
- UserPreferenceId; integer; カタログ品目によって参照されるユーザー・プリファレンスを一意に識別する値。
- FindByRequisitionLineId: 購買依頼明細によって参照される品目の詳細を検索します。
ファインダ変数:- RequisitionLineId; integer; 情報が問い合せられる購買依頼明細を一意に識別する値。
- PrimaryKey : 主キーに従ってカタログ品目詳細を検索します。
ファインダ変数:- SearchObjectId; integer; カタログ品目によって参照される検索オブジェクトを一意に識別する値。
- FindById : 検索オブジェクト識別子およびユーザー・プリファレンス識別子に従って、カタログ品目詳細を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- SearchObjectId; integer; カタログ品目によって参照される検索オブジェクトを一意に識別する値。
- SourceDocumentHeaderId; integer; アグリーメント・ヘッダーを一意に識別する値。
- SourceDocumentLineId; integer; 契約明細を一意に識別する値。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : shoppingCatalogItemDetails
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲内で返されるリソース・インスタンス数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内の品目。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合、推定行数は含まれません。
ネストされたスキーマ : shoppingCatalogItemDetails-item-response
タイプ:
ソースを表示
object
-
AllowMasterItemDescriptionUpdateFlag: boolean
タイトル:
Allow Purchasing Document Description Update
読取り専用:true
最大長:1
次のいずれかの値が含まれます: true、falseまたはNULL。 trueの場合、マスター品目で購買文書の摘要更新が許可されます。 falseの場合、マスター品目は購買文書の摘要更新を許可しません。 NULLの場合、値は使用できません。 この属性にはデフォルト値がありません。 -
AllowPriceOverrideForBPAFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: true、falseまたはNULL。 trueの場合、包括購買契約明細で価格上書きが許可されます。 falseの場合、包括購買契約明細では価格上書きが許可されません。 NULLの場合、値は使用できません。 この属性にはデフォルト値がありません。 -
Amount: number
読取り専用:
true
購買会社の通貨でのサービス品目の金額。 -
Availability: string
タイトル:
Availability
読取り専用:true
最大長:700
商品およびサービスの可用性を示す値です。 -
BPAPriceLimit: number
タイトル:
Price Limit
読取り専用:true
価格上書きを許可する包括購買契約明細に設定された価格限度。 -
buyingOptions: array Buying Options
タイトル:
Buying Options
購買オプション・リソースは、複数の契約によって品目が参照されるときに、様々な購買オプションを取得します。 -
CategoryName: string
読取り専用:
true
最大長:255
契約明細を分類するカテゴリの名前です。 -
Comments: string
タイトル:
Comments
読取り専用:true
最大長:700
契約明細に関するコメント。 -
CreatedBy: string
読取り専用:
true
最大長:64
品目詳細を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーが品目詳細を作成した日付。 -
CurrencyCode: string
読取り専用:
true
品目通貨を識別する略称です。 -
ImageURL: string
読取り専用:
true
最大長:700
契約明細のイメージのURL (Uniform Resource Locator)。 -
InternallyTransferableItemFlag: boolean
タイトル:
Shippable
読取り専用:true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、品目は内部的に転送可能です。 falseの場合、品目は内部転送可能ではありません。 この属性にはデフォルト値がありません。 -
InternalTransferOrderEnabledFlag: boolean
タイトル:
Transfer Orders Enabled
読取り専用:true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、品目は内部移動伝票に対して有効になります。 falseの場合、社内転送オーダーの品目は無効です。 この属性にはデフォルト値がありません。 -
ItemCatalogCategoryId: integer
読取り専用:
true
品目のカテゴリを一意に識別する値。 -
itemGTINRelationships: array Item GTIN Relationships
タイトル:
Item GTIN Relationships
品目GTIN関連リソースは、マスター品目のグローバル取引品目番号(GTIN)詳細を取得します。 -
itemImages: array Item Images
タイトル:
Item Images
品目イメージ・リソースは、マスター品目のイメージを取得します。 -
itemManufacturers: array Item Manufacturers
タイトル:
Item Manufacturers
品目製造業者リソースは、マスター品目の製造業者詳細を取得します。 -
ItemNumber: string
読取り専用:
true
最大長:300
マスター品目の名前。 -
ItemRevision: string
読取り専用:
true
最大長:255
マスター品目の改訂。 -
itemSuppliers: array Item Suppliers
タイトル:
Item Suppliers
品目サプライヤ・リソースは、マスター品目のサプライヤ詳細を取得します。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが品目詳細を最後に更新した日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
品目詳細を最後に更新したユーザー。 -
LeadTime: number
タイトル:
Lead Time Days
読取り専用:true
オーダーの発行後にサプライヤが商品を搬送するのに要した時間。 -
LineType: string
タイトル:
Line Type
読取り専用:true
最大長:30
契約明細のタイプです。 有効な値は、物品またはサービスまたはユーザー定義明細タイプです。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LongDescription: string
読取り専用:
true
最大長:255
品目の詳細摘要。 -
Manufacturer: string
読取り専用:
true
最大長:700
品目を製造するパーティの名前です。 -
ManufacturerPartNumber: string
読取り専用:
true
最大長:700
個々の製品を一意に識別する製造業者によって発行された番号。 -
OrderTypeLookupCode: string
読取り専用:
true
最大長:25
契約明細のタイプを識別する略称です。 有効な値は、QUANTITY ServicesまたはFIXED Servicesです。 -
PackagingString: string
読取り専用:
true
最大長:255
梱包済供給品目の単位。 -
PurchasingEnabledFlag: boolean
タイトル:
Purchasable
読取り専用:true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、品目は購買可能になります。 falseの場合、品目は購買に対して使用不可になります。 この属性にはデフォルト値がありません。 -
RestrictSubinventories: string
読取り専用:
true
品目が保管場所によって制限されるかどうかを指定する値。 -
SearchObjectId: integer (int64)
カタログ品目によって参照される検索オブジェクトを一意に識別する値。
-
ShortDescription: string
読取り専用:
true
最大長:255
品目の摘要。 -
SourceDocumentHeaderId: integer (int64)
契約ヘッダーを一意に識別する値。
-
SourceDocumentHeaderNumber: string
タイトル:
Agreement
読取り専用:true
最大長:30
品目が使用可能な契約を識別する番号。 -
SourceDocumentLineId: integer (int64)
契約明細を一意に識別する値です。
-
StockEnabled: string
タイトル:
Stocked
読取り専用:true
最大長:1
品目が搬送先組織で在庫可能かどうかを指定する値です。 -
SupplierItem: string
読取り専用:
true
最大長:300
サプライヤ品目を識別する番号。 -
SupplierItemAuxiliaryId: string
読取り専用:
true
最大長:255
サプライヤ品目補助を一意に識別する値。 -
SupplierName: string
読取り専用:
true
最大長:360
品目または契約のサプライヤの名前。 -
UnitOfMeasure: string
読取り専用:
true
最大長:255
品目が使用する単位。 -
UnitPrice: number
読取り専用:
true
購買会社の通貨での品目の価格。 -
UNSPSC: string
タイトル:
UNSPSC
読取り専用:true
最大長:700
購買される商品およびサービスを一意に識別する値。 -
UOMCode: string
読取り専用:
true
最大長:255
単位を識別する略語。
ネストされたスキーマ : 購入オプション
タイプ:
array
タイトル:
Buying Options
購買オプション・リソースは、複数の契約によって品目が参照されるときに、様々な購買オプションを取得します。
ソースを表示
ネストされたスキーマ : 品目GTIN関連
タイプ:
array
タイトル:
Item GTIN Relationships
品目GTIN関連リソースは、マスター品目のグローバル取引品目番号(GTIN)詳細を取得します。
ソースを表示
ネストされたスキーマ : shoppingCatalogItemDetails-buyingOptions-item-response
タイプ:
ソースを表示
object
-
Amount: number
読取り専用:
true
購買会社の通貨でのサービス品目の金額。 -
CategoryName: string
読取り専用:
true
最大長:250
契約明細を分類するカテゴリの名前です。 -
Comments: string
タイトル:
Comments
読取り専用:true
最大長:700
契約明細に関するコメント。 -
CurrencyCode: string
読取り専用:
true
最大長:15
品目通貨を識別する略称です。 -
ImageURL: string
読取り専用:
true
最大長:255
契約明細のイメージのURL (Uniform Resource Locator)。 -
ItemNumber: string
読取り専用:
true
最大長:300
マスター品目の名前。 -
LineType: string
タイトル:
Line Type
読取り専用:true
最大長:30
契約明細のタイプです。 有効な値は、「商品」または「サービス」です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LongDescription: string
読取り専用:
true
最大長:255
品目の詳細摘要。 -
Manufacturer: string
タイトル:
Manufacturer
読取り専用:true
最大長:700
品目を製造するパーティの名前です。 -
ManufacturerPartNumber: string
タイトル:
Manufacturer Part Number
読取り専用:true
最大長:700
個々の製品を一意に識別する製造業者によって発行された番号。 -
PackagingString: string
読取り専用:
true
最大長:255
梱包済供給品目の単位。 -
SearchObjectId: integer (int64)
購買される商品およびサービスを一意に識別する値。
-
ShortDescription: string
タイトル:
Description
読取り専用:true
最大長:240
品目の摘要。 -
SourceDocumentHeaderId: integer (int64)
契約ヘッダーを一意に識別する値。
-
SourceDocumentHeaderNumber: string
タイトル:
Agreement
読取り専用:true
最大長:30
品目が使用可能な契約を識別する番号。 -
SourceDocumentLineId: integer (int64)
契約明細を一意に識別する値です。
-
SupplierItem: string
タイトル:
Supplier Item
読取り専用:true
最大長:300
サプライヤ品目を識別する番号。 -
SupplierItemAuxiliaryId: string
タイトル:
Supplier Item Auxiliary Identifier
読取り専用:true
最大長:255
サプライヤ品目補助を一意に識別する値。 -
SupplierName: string
読取り専用:
true
最大長:360
契約明細のサプライヤの名前。 -
UnitPrice: number
タイトル:
Price
読取り専用:true
購買会社の通貨での品目の価格。 -
UNSPSC: string
タイトル:
UNSPSC
読取り専用:true
最大長:700
購買される商品およびサービスを一意に識別する値。 -
UOMCode: string
タイトル:
UOM Code
読取り専用:true
最大長:3
単位を識別する略語。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : shoppingCatalogItemDetails-itemGTINRelationships-item-response
タイプ:
ソースを表示
object
-
GTIN: string
タイトル:
GTIN
読取り専用:true
最大長:255
マスター品目のグローバル取引品目番号(GTIN)を一意に識別する値。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PartyType: string
読取り専用:
true
最大長:255
グローバル取引品目番号(GTIN)のパーティのタイプです。 値は、空白、サプライヤまたは製造業者です。 -
UOM: string
タイトル:
UOM
読取り専用:true
最大長:25
グローバル取引品目番号(GTIN)が定義されている単位を識別する略称です。
ネストされたスキーマ : shoppingCatalogItemDetails-itemImages-item-response
タイプ:
ソースを表示
object
-
DownloadInfo: string
タイトル:
DownloadInfo
ファイル添付をプログラムで取得するために必要な情報を含むJSON形式の文字列。 -
FileWebImage: string (byte)
タイトル:
File Web Image
読取り専用:true
Base64でエンコードされた、.png形式で表示されるファイルのイメージ(ソースが変換可能なイメージの場合)。 -
ItemImageURL: string
読取り専用:
true
品目イメージのUniform Resource Locator (URL)。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。
ネストされたスキーマ : shoppingCatalogItemDetails-itemManufacturers-item-response
タイプ:
ソースを表示
object
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Manufacturer: string
タイトル:
Manufacturer
読取り専用:true
最大長:360
品目の製造業者の名前。 -
ManufacturerPartNumber: string
タイトル:
Manufacturer Part Number
読取り専用:true
最大長:150
個々の部品を一意に識別する製造業者によって発行された番号。 このアトリビュートは、パーツを類似パーツや偽造と区別します。
ネストされたスキーマ : shoppingCatalogItemDetails-itemSuppliers-item-response
タイプ:
ソースを表示
object
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Supplier: string
タイトル:
Supplier
読取り専用:true
最大長:360
マスター品目のサプライヤの名前。 -
SupplierPartNumber: string
タイトル:
Supplier Item
読取り専用:true
最大長:150
個々の部品を一意に識別するサプライヤが発行した番号。 このアトリビュートは、パーツを類似パーツや偽造と区別します。