Salesforce Docs Portal

TMF671 v4 Promotion Management

GET List Promotions

GET /promotion

Retrieves a list of Promotion entities. Attribute selection is enabled for first-level attributes and filtering is supported for name.

Parameters

  • fields (query, string) fields for attribute selection.
  • name (query, string) Name of the promotion
  • offset (query, integer) Specifies the requested index for the start of the resources to be included in the response.
  • pageLimit (query, integer) Specifies the requested number of the resources to be included in the response.
  • pageInfo (query, boolean) Enables customer to get pageinformation with GET response.
  • Authorization (header, string, required) Specifies the bearer token to use for the authentication of request.
  • Domain-Name (header, string, required) Specifies the domain name to use with the URL path received from the userinfo API.
  • Version (header, string, required) Specifies the version to use with the URL path.

Responses

  • 200 successfully retrieved the promotion list

    Media type: application/json. Schema: array of promotion.

    Array of promotion.

  • 404 Resource not found.

    Media type: application/json. Schema: Error.

    Example

    code: NOT_FOUND
reason: There are no matching resource.
  • 500 Internal server error

    Media type: application/json. Schema: Error.

    Example

    code: "500"
reason: Internal server error