Jump to

• Request
• Response

Update a default price

patch

/crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices/{DefaultPriceId}

Request

Path Parameters

• DefaultPriceId(required): integer(int64)
  The unique identifier of the default price. This value is generated when the default price is created.
• InventoryItemId(required): integer(int64)
  The unique identifier of the inventory item. This value is generated when the product is created.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ListPrice: number
  Title: List Price

  Default Value: 0

  The List Price for the combination of product, currency and UOM.
• PriceUOMCode: string
  Title: UOM

  Maximum Length: 30

  The unit of measurement code of the default price.

{
    "type":"object",
    "properties":{
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The List Price for the combination of product, currency and UOM.",
            "nullable":true,
            "default":"0"
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measurement code of the default price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : products-DefaultPrices-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the default price.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the default price was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The code for the Currency of the default price.
• DefaultPriceId: integer (int64)
  Read Only: true

  The unique identifier of the default price. This value is generated when the default price is created.
• InvItemId: integer (int64)
  Title: Inventory Item ID

  Read Only: true

  The unique identifier of the inventory item associated with the default price
• InvOrgId: integer (int64)
  Read Only: true

  The unique identifier of the inventory organization associated with the default price.
• ItemNumber: string
  Title: Product Number

  Maximum Length: 300

  The unique alternate identifier of the product.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the default price was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the default price.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the default price.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  Title: List Price

  Default Value: 0

  The List Price for the combination of product, currency and UOM.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• PricebookId: integer (int64)
  The unique identifier of the price book associated with the default price
• PriceBookName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name of the Price book associated with the Default Price.
• PriceUOMCode: string
  Title: UOM

  Maximum Length: 30

  The unit of measurement code of the default price.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the default price.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the default price was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with the default price.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the default price.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBookName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the Price book associated with the Default Price.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The List Price for the combination of product, currency and UOM.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "DefaultPriceId":{
            "type":"integer",
            "description":"The unique identifier of the default price. This value is generated when the default price is created.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The code for the Currency of the default price.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measurement code of the default price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The unique alternate identifier of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "InvItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item associated with the default price",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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 and time when the default price 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 default price.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricebookId":{
            "type":"integer",
            "description":"The unique identifier of the price book associated with the default price",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Back to Top