Jump to

• Request
• Response

Create a campaign product

post

/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignProducts

Request

Path Parameters

• CampaignNumber(required): string
  The alternate key identifier of the campaign.

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

• CampaignId: integer (int64)
  Title: Campaign ID

  The unique identifier of the campaign.
• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The unique identifier of the campaign to which the campaign product belongs to.
• CampaignProductId: integer (int64)
  Title: Campaign Product ID

  The unique identifier of the campaign product.
• CampaignProductNumber: string
  Title: Campaign Product Number

  Maximum Length: 30

  The alternate key identifier of the campaign product.
• InventoryItemId: integer (int64)
  Title: Campaign Inventory Item ID

  The unique inventory item identifier associated with the campaign product.
• InventoryOrgId: integer (int64)
  Title: Campaign Inventory Org ID

  The unique inventory organization identifier associated with this campaign product.
• ProductGroupId: integer (int64)
  Title: Campaign Product Group ID

  The unique identifier of the product group.
• ProductGroupNumber: string
  Title: Reference Number

  Maximum Length: 50

  The alternate key for referenced product group.
• ProductType: string
  Title: Product Type

  The type of the product, such as item or product group.

{
    "type":"object",
    "properties":{
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign product belongs to.",
            "nullable":false
        },
        "CampaignProductId":{
            "title":"Campaign Product ID",
            "type":"integer",
            "description":"The unique identifier of the campaign product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignProductNumber":{
            "title":"Campaign Product Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign product.",
            "nullable":false
        },
        "InventoryItemId":{
            "title":"Campaign Inventory Item ID",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "InventoryOrgId":{
            "title":"Campaign Inventory Org ID",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductGroupId":{
            "title":"Campaign Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "ProductGroupNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":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 : campaigns-CampaignProducts-item-response

Type: object

Show Source

• CampaignId: integer (int64)
  Title: Campaign ID

  The unique identifier of the campaign.
• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The unique identifier of the campaign to which the campaign product belongs to.
• CampaignProductId: integer (int64)
  Title: Campaign Product ID

  The unique identifier of the campaign product.
• CampaignProductNumber: string
  Title: Campaign Product Number

  Maximum Length: 30

  The alternate key identifier of the campaign product.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the campaign products.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the campaign product was created.
• InventoryItemId: integer (int64)
  Title: Campaign Inventory Item ID

  The unique inventory item identifier associated with the campaign product.
• InventoryOrgId: integer (int64)
  Title: Campaign Inventory Org ID

  The unique inventory organization identifier associated with this campaign product.
• ItemName: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  The product description where the product is associated with the campaign.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  The alternate key for referenced inventory item.
• LastUpdateDate: string (date-time)
  Title: Last Updated

  Read Only: true

  The date when the campaign product was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the campaign product.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductGroupId: integer (int64)
  Title: Campaign Product Group ID

  The unique identifier of the product group.
• ProductGroupName: string
  Title: Display

  Read Only: true

  Maximum Length: 250

  The description of the product group where the product group is associated with the campaign.
• ProductGroupNumber: string
  Title: Reference Number

  Maximum Length: 50

  The alternate key for referenced product group.
• ProductType: string
  Title: Product Type

  The type of the product, such as item or product group.

{
    "type":"object",
    "properties":{
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign product belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignProductId":{
            "title":"Campaign Product ID",
            "type":"integer",
            "description":"The unique identifier of the campaign product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignProductNumber":{
            "title":"Campaign Product Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign product.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign products.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign product was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Campaign Inventory Item ID",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"CRMProduct"
            },
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Campaign Inventory Org ID",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The product description where the product is associated with the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"The alternate key for referenced inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign product was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductGroupId":{
            "title":"Campaign Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"CRMProductGroup"
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Display",
            "maxLength":250,
            "type":"string",
            "description":"The description of the product group where the product group is associated with the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":false
        },
        "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."
        }
    }
}

Links

ProductTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_LEAD_PRODUCT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: ProductType; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top