Jump to

• Request
• Response

Update an item translation - Not Supported

patch

/crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/ItemTranslation/{ItemTranslationUniqID}

Request

Path Parameters

• ItemTranslationUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- InventoryItemId, OrganizationId and Language ---for the Item Translation resource and used to uniquely identify an instance of Item Translation. The client should not generate the hash key value. Instead, the client should query on the Item Translation collection resource with a filter on the primary key values in order to navigate to a specific instance of Item Translation.
  
  For example: ItemTranslation?q=InventoryItemId=<value1>;OrganizationId=<value2>;Language=<value3>
• catalogProductItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ProductGroupDenormId, InventoryItemId and OrganizationId ---for the Catalog Products Items resource and used to uniquely identify an instance of Catalog Products Items. The client should not generate the hash key value. Instead, the client should query on the Catalog Products Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Catalog Products Items.
  
  For example: catalogProductItems?q=ProductGroupDenormId=<value1>;InventoryItemId=<value2>;OrganizationId=<value3>

Header Parameters

• Metadata-Context: string
  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: string
  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

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

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 : catalogProductItems-ItemTranslation-item-response

Type: object

Show Source

• Description: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  The translated description of the item.
• InventoryItemId: integer (int64)
  Title: Item Number

  Read Only: true

  The unique identifier of the inventory item.
• ISOLanguage: string
  Read Only: true

  Maximum Length: 2

  The ISO language associated with the product item like English or Danish.
• ISOTerritory: string
  Title: Territory

  Read Only: true

  Maximum Length: 2

  The ISO territory associated with the product item.
• Language: string
  Read Only: true

  Maximum Length: 4

  The translation language of the item.
• LanguageCode: string
  Title: Language Code

  Read Only: true

  Maximum Length: 4

  The language code associated with the product item like 639-1en (English) or 639-1da (Danish).
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string
  Title: Long Description

  Read Only: true

  Maximum Length: 4000

  The long translated description of the item.
• OrganizationId: integer (int64)
  Title: Organization

  Read Only: true

  The unique identifier of the organization to which the item belongs.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The translated description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ISOLanguage":{
            "maxLength":2,
            "type":"string",
            "description":"The ISO language associated with the product item like English or Danish.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ISOTerritory":{
            "title":"Territory",
            "maxLength":2,
            "type":"string",
            "description":"The ISO territory associated with the product item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"The translation language of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LanguageCode":{
            "title":"Language Code",
            "maxLength":4,
            "type":"string",
            "description":"The language code associated with the product item like 639-1en (English) or 639-1da (Danish).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"The long translated description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique identifier of the organization to which the item belongs.",
            "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"
            }
        }
    }
}

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