機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

価格表の作成

post

/crmRestApi/resources/11.13.18.05/priceBookHeaders

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• CurrencyCode: string
  タイトル: Currency

  最大長: 15

  価格台帳金額の通貨。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• DefaultPricebookFlag: boolean
  タイトル: Default Price Book

  最大長: 1

  デフォルト値: false

  通貨のデフォルト価格台帳であるかどうかを示します。
• Description: string
  タイトル: Description

  最大長: 1999

  価格台帳の簡単な説明。
• HeaderExternalKey: string
  タイトル: Header External Key

  最大長: 120

  価格台帳の外部キー値。
• HeaderExternalSource: string
  タイトル: Header External Source

  最大長: 120

  デフォルト値: PB_HEADER

  価格台帳の外部キーのソース。
• Name(required): string
  タイトル: Name

  最大長: 150

  価格台帳の名前。
• PricebookCode: string
  タイトル: Price Book Code

  最大長: 80

  価格台帳を示すコード。 この値は、価格表の作成時に自動生成されます。
• PricebookId: integer (int64)
  タイトル: Price Book ID

  価格台帳の一意の識別子。
• PriceBookItem: array Price Book Items
  タイトル: Price Book Items

  価格表明細リソースは、価格台帳で選択した品目の品目識別子、一意の識別子および一意の識別子を表示、作成、更新および削除するために使用します。 また、品目の摘要、価格および単位も含まれます。
• StatusCode: string
  タイトル: Status

  最大長: 30

  デフォルト値: DRAFT

  価格台帳のステータスを示すコード。 たとえば、ドラフト、アクティブまたは失効済です。
• StatusSearchLovVA: array Status Search
  タイトル: Status Search

  ステータス検索リソースを使用すると、価格表のステータスを検索できます。

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StatusSearchLovVA":{
            "title":"Status Search",
            "type":"array",
            "description":"The Status Search resource lets you search for the status of a pricebook.",
            "items":{
                "$ref":"#/components/schemas/priceBookHeaders-StatusSearchLovVA-item-post-request"
            }
        },
        "HeaderExternalKey":{
            "title":"Header External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key value for the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1999,
            "type":"string",
            "description":"A brief description of the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderExternalSource":{
            "title":"Header External Source",
            "maxLength":120,
            "type":"string",
            "description":"The source for the external key of the price book.",
            "nullable":true,
            "default":"PB_HEADER",
            "x-queryable":true
        },
        "PriceBookItem":{
            "title":"Price Book Items",
            "type":"array",
            "description":"The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.",
            "items":{
                "$ref":"#/components/schemas/priceBookHeaders-PriceBookItem-item-post-request"
            }
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":80,
            "type":"string",
            "description":"The code indicating the price book. This value is auto-generated when a pricebook is created.",
            "nullable":false,
            "x-queryable":true
        },
        "DefaultPricebookFlag":{
            "title":"Default Price Book",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if it is the default price book for the currency.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the price book. For example, Draft, Active, or Expired.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "PricebookId":{
            "title":"Price Book ID",
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the price book.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 価格表アイテム

タイプ: array

タイトル: Price Book Items

価格表明細リソースは、価格台帳で選択した品目の品目識別子、一意の識別子および一意の識別子を表示、作成、更新および削除するために使用します。 また、品目の摘要、価格および単位も含まれます。

ソースを表示

• Array of: object priceBookHeaders-PriceBookItem-item-post-request

{
    "title":"Price Book Items",
    "type":"array",
    "description":"The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.",
    "items":{
        "$ref":"#/components/schemas/priceBookHeaders-PriceBookItem-item-post-request"
    }
}

ネストされたスキーマ : ステータス検索

タイプ: array

タイトル: Status Search

ステータス検索リソースを使用すると、価格表のステータスを検索できます。

ソースを表示

• Array of: object priceBookHeaders-StatusSearchLovVA-item-post-request

{
    "title":"Status Search",
    "type":"array",
    "description":"The Status Search resource lets you search for the status of a pricebook.",
    "items":{
        "$ref":"#/components/schemas/priceBookHeaders-StatusSearchLovVA-item-post-request"
    }
}

ネストされたスキーマ : priceBookHeaders-PriceBookItem-item-post-request

タイプ: object

ソースを表示

• CurrencyCode: string
  最大長: 15

  価格台帳金額の通貨。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域を使用して、プロファイル・オプションをレビューおよび更新します。
• InvItemId: integer (int64)
  タイトル: Inventory Item ID

  価格台帳で選択された品目の一意の識別子。
• InvOrgId: integer (int64)
  価格台帳で選択された品目に関連付けられた在庫組織の一意の識別子。
• ItemDescription: string
  タイトル: Name

  価格台帳品目の簡単な摘要。
• ItemExternalKey: string
  タイトル: External Key

  最大長: 120

  価格台帳品目の外部キー値。
• ItemExternalSource: string
  タイトル: External Source

  最大長: 120

  デフォルト値: PB_LINE

  価格台帳品目の外部キーのソース。
• ListPrice: number
  タイトル: List Price

  デフォルト値: 0

  品目の価格。
• PricebookCode: string
  タイトル: Price Book Code

  最大長: 80
• PricebookId: integer (int64)
  価格台帳の一意の識別子。
• PricebookItemId: integer (int64)
  価格台帳品目の一意の識別子。
• PriceUOMCode: string
  タイトル: UOM

  最大長: 30

  品目の単位。

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement of the item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemExternalSource":{
            "title":"External Source",
            "maxLength":120,
            "type":"string",
            "description":"The source for the external key of the price book item.",
            "nullable":true,
            "default":"PB_LINE",
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the item selected in the price book.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key value for the price book item.",
            "nullable":true,
            "x-queryable":true
        },
        "InvItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item selected in the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PricebookItemId":{
            "type":"integer",
            "description":"The unique identifier of the price book item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the item.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Name",
            "type":"string",
            "description":"A brief description of the price book item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PricebookId":{
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : priceBookHeaders-StatusSearchLovVA-item-post-request

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : priceBookHeaders-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• CurrencyCode: string
  タイトル: Currency

  最大長: 15

  価格台帳金額の通貨。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• DefaultPricebookFlag: boolean
  タイトル: Default Price Book

  最大長: 1

  デフォルト値: false

  通貨のデフォルト価格台帳であるかどうかを示します。
• DeleteFlag: boolean
  読取り専用: true

  価格台帳を削除できるかどうかを示します。 デフォルト値はtrueです。
• Description: string
  タイトル: Description

  最大長: 1999

  価格台帳の簡単な説明。
• HeaderExternalKey: string
  タイトル: Header External Key

  最大長: 120

  価格台帳の外部キー値。
• HeaderExternalSource: string
  タイトル: Header External Source

  最大長: 120

  デフォルト値: PB_HEADER

  価格台帳の外部キーのソース。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  タイトル: Name

  最大長: 150

  価格台帳の名前。
• PricebookCode: string
  タイトル: Price Book Code

  最大長: 80

  価格台帳を示すコード。 この値は、価格表の作成時に自動生成されます。
• PricebookId: integer (int64)
  タイトル: Price Book ID

  価格台帳の一意の識別子。
• PriceBookItem: array Price Book Items
  タイトル: Price Book Items

  価格表明細リソースは、価格台帳で選択した品目の品目識別子、一意の識別子および一意の識別子を表示、作成、更新および削除するために使用します。 また、品目の摘要、価格および単位も含まれます。
• StatusCode: string
  タイトル: Status

  最大長: 30

  デフォルト値: DRAFT

  価格台帳のステータスを示すコード。 たとえば、ドラフト、アクティブまたは失効済です。
• StatusSearchLovVA: array Status Search
  タイトル: Status Search

  ステータス検索リソースを使用すると、価格表のステータスを検索できます。
• UpdateFlag: boolean
  読取り専用: true

  価格台帳を更新できるかどうかを示します。 デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1999,
            "type":"string",
            "description":"A brief description of the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderExternalSource":{
            "title":"Header External Source",
            "maxLength":120,
            "type":"string",
            "description":"The source for the external key of the price book.",
            "nullable":true,
            "default":"PB_HEADER",
            "x-queryable":true
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":80,
            "type":"string",
            "description":"The code indicating the price book. This value is auto-generated when a pricebook is created.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the price book. For example, Draft, Active, or Expired.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the price book can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the price book.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StatusSearchLovVA":{
            "title":"Status Search",
            "type":"array",
            "description":"The Status Search resource lets you search for the status of a pricebook.",
            "items":{
                "$ref":"#/components/schemas/priceBookHeaders-StatusSearchLovVA-item-response"
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the price book can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderExternalKey":{
            "title":"Header External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key value for the price book.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceBookItem":{
            "title":"Price Book Items",
            "type":"array",
            "description":"The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.",
            "items":{
                "$ref":"#/components/schemas/priceBookHeaders-PriceBookItem-item-response"
            }
        },
        "DefaultPricebookFlag":{
            "title":"Default Price Book",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if it is the default price book for the currency.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PricebookId":{
            "title":"Price Book ID",
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 価格表アイテム

タイプ: array

タイトル: Price Book Items

価格表明細リソースは、価格台帳で選択した品目の品目識別子、一意の識別子および一意の識別子を表示、作成、更新および削除するために使用します。 また、品目の摘要、価格および単位も含まれます。

ソースを表示

• Array of: object priceBookHeaders-PriceBookItem-item-response

{
    "title":"Price Book Items",
    "type":"array",
    "description":"The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.",
    "items":{
        "$ref":"#/components/schemas/priceBookHeaders-PriceBookItem-item-response"
    }
}

ネストされたスキーマ : ステータス検索

タイプ: array

タイトル: Status Search

ステータス検索リソースを使用すると、価格表のステータスを検索できます。

ソースを表示

• Array of: object priceBookHeaders-StatusSearchLovVA-item-response

{
    "title":"Status Search",
    "type":"array",
    "description":"The Status Search resource lets you search for the status of a pricebook.",
    "items":{
        "$ref":"#/components/schemas/priceBookHeaders-StatusSearchLovVA-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : priceBookHeaders-PriceBookItem-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• CurrencyCode: string
  最大長: 15

  価格台帳金額の通貨。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域を使用して、プロファイル・オプションをレビューおよび更新します。
• InvItemId: integer (int64)
  タイトル: Inventory Item ID

  価格台帳で選択された品目の一意の識別子。
• InvOrgId: integer (int64)
  価格台帳で選択された品目に関連付けられた在庫組織の一意の識別子。
• ItemDescription: string
  タイトル: Name

  価格台帳品目の簡単な摘要。
• ItemExternalKey: string
  タイトル: External Key

  最大長: 120

  価格台帳品目の外部キー値。
• ItemExternalSource: string
  タイトル: External Source

  最大長: 120

  デフォルト値: PB_LINE

  価格台帳品目の外部キーのソース。
• ItemNumber: string
  読取り専用: true

  最大長: 300

  価格台帳金額の品目。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_ITEMで定義されます。 「設定およびメンテナンス」作業領域を使用して、プロファイル・オプションをレビューおよび更新します。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ListPrice: number
  タイトル: List Price

  デフォルト値: 0

  品目の価格。
• PricebookCode: string
  タイトル: Price Book Code

  最大長: 80
• PricebookId: integer (int64)
  価格台帳の一意の識別子。
• PricebookItemId: integer (int64)
  価格台帳品目の一意の識別子。
• PriceUOMCode: string
  タイトル: UOM

  最大長: 30

  品目の単位。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemExternalSource":{
            "title":"External Source",
            "maxLength":120,
            "type":"string",
            "description":"The source for the external key of the price book item.",
            "nullable":true,
            "default":"PB_LINE",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the item selected in the price book.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricebookCode":{
            "title":"Price Book Code",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PricebookItemId":{
            "type":"integer",
            "description":"The unique identifier of the price book item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the item.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Name",
            "type":"string",
            "description":"A brief description of the price book item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement of the item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The item of the price book amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_ITEM. Review and update the profile option using the Setup and Maintenance work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key value for the price book item.",
            "nullable":true,
            "x-queryable":true
        },
        "InvItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item selected in the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricebookId":{
            "type":"integer",
            "description":"The unique identifier of the price book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : priceBookHeaders-StatusSearchLovVA-item-response

タイプ: object

ソースを表示

• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• LookupCode: string
  タイトル: Lookup Code

  読取り専用: true

  最大長: 30

  FND参照のタイプを示すコード。 有効な値のリストは、参照ORA_QSC_PRICE_BOOK_STATUSで定義されます。
• LookupType: string
  タイトル: Lookup Type

  読取り専用: true

  最大長: 30

  FND参照のタイプ。
• Meaning: string
  タイトル: Meaning

  読取り専用: true

  最大長: 80

  参照の意味。
• Tag: string
  タイトル: Tag

  読取り専用: true

  最大長: 150

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Tag":{
            "title":"Tag",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the FND Lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of FND Lookup. A list of valid values is defined in the lookup ORA_QSC_PRICE_BOOK_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

PriceBookItem

操作: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem

パラメータ:

• priceBookHeaders_Id: $request.path.priceBookHeaders_Id

価格表明細リソースは、価格台帳で選択した品目の品目識別子、一意の識別子および一意の識別子を表示、作成、更新および削除するために使用します。 また、品目の摘要、価格および単位も含まれます。

StatusCodeLovForUIVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_QSC_PRICE_BOOK_STATUS

価格台帳に関連付けられた様々なステータス・コードのリスト。 この属性の最大値は30です。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: StatusCode;ターゲット属性: LookupCode
• 表示属性: 意味

StatusSearchLovVA

操作: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/StatusSearchLovVA

パラメータ:

• priceBookHeaders_Id: $request.path.priceBookHeaders_Id

ステータス検索リソースを使用すると、価格表のステータスを検索できます。

YesNoPricebookFlagFndLookupsVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

価格台帳が通貨のデフォルトであるかどうかを示す値リスト。 有効な値はYおよびNです。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: DefaultPricebookFlag;ターゲット属性: LookupCode
• 表示属性: 意味

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、価格表ヘッダーを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/priceBookHeaders

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{

"CurrencyCode" : "USD",

"Name" : "Test/PriceBook/001",

"Description" : "Test Pricebook 001",

"StatusCode" : "DRAFT"

}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "PricebookCode" : "74c5a19c-fc12-4999-8ffc-f2996a1149c6",
  "CurrencyCode" : "USD",
  "Name" : "Test/PriceBook/001",
  "Description" : "Test Pricebook 001",
  "StatusCode" : "DRAFT",
  "CustomAttr_c" : null,
  "TestSearch_c" : "tw",
  "TestAttr_c" : null,
  "links" : [ {
   . . .
  } ]
}

「トップに戻る」