Jump to

• Request
• Response

Create a product relationship on a product group and lock it

post

/crmRestApi/resources/11.13.18.05/productGroupProducts

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the item is active in the group.
• DisplayOrderNum: integer (int64)
  Title: Display Sequence

  Manually set display order for items in a product group.
• EndDate: string (date-time)
  Title: Effective to Date

  The date until which the item is active in the group.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of an inventory item.
• InvOrgId: integer (int64)
  The unique identifier of an inventory organization for an item.
• ParPGReferenceNumber: string
  Title: Parent Product Group Reference Number

  Maximum Length: 50

  The reference number of the parent product group.
• ProdGroupId: integer (int64)
  The unique identifier of the product group.
• ProdGroupItemsId: integer (int64)
  The unique identifier of the product group item.
• StartDate: string (date-time)
  Title: Effective from Date

  The date from which the item is active in the group.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the item is active in the group.",
            "nullable":false,
            "default":true
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Manually set display order for items in a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date until which the item is active in the group.",
            "format":"date-time",
            "nullable":false
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of an inventory organization for an item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of an inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ParPGReferenceNumber":{
            "title":"Parent Product Group Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The reference number of the parent product group.",
            "nullable":false
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProdGroupItemsId":{
            "type":"integer",
            "description":"The unique identifier of the product group item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the item is active in the group.",
            "format":"date-time",
            "nullable":false
        }
    }
}

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 : productGroupProducts-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the item is active in the group.
• Description: string
  Title: Product

  Read Only: true

  Maximum Length: 240

  The description of the product.
• DisplayOrderNum: integer (int64)
  Title: Display Sequence

  Manually set display order for items in a product group.
• EndDate: string (date-time)
  Title: Effective to Date

  The date until which the item is active in the group.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of an inventory item.
• InvOrgId: integer (int64)
  The unique identifier of an inventory organization for an item.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 4000

  The detailed description of the item.
• ParPGReferenceNumber: string
  Title: Parent Product Group Reference Number

  Maximum Length: 50

  The reference number of the parent product group.
• ProdGroupId: integer (int64)
  The unique identifier of the product group.
• ProdGroupItemsId: integer (int64)
  The unique identifier of the product group item.
• ProductNumber: string
  Title: Product Number

  Read Only: true

  Maximum Length: 300

  The unique alternate identifier of the product.
• StartDate: string (date-time)
  Title: Effective from Date

  The date from which the item is active in the group.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the item is active in the group.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Product",
            "maxLength":240,
            "type":"string",
            "description":"The description of the product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Manually set display order for items in a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date until which the item is active in the group.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of an inventory organization for an item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of an inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The detailed description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParPGReferenceNumber":{
            "title":"Parent Product Group Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The reference number of the parent product group.",
            "nullable":false,
            "x-queryable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProdGroupItemsId":{
            "type":"integer",
            "description":"The unique identifier of the product group item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":300,
            "type":"string",
            "description":"The unique alternate identifier of the product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the item is active in the group.",
            "format":"date-time",
            "nullable":false,
            "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