1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Order Management
  4. Sales Orders for Order Hub
  5. Promotion Codes

Get all promotion codes

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/promotionCodes

Request

Path Parameters
  • Value that uniquely identifies the sales order. It can have the following formats.

    - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
    Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".

    - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
    Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.

    When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds promo code according to the primary key.
      Finder Variables:
      • PromocodeId; integer; Value that uniquely identifies the promotion code applied to the sales order.
    • findByHeaderIdAndPromotionCode: Finds promotion code accodrding to the sales order identifier and the promotion code.
      Finder Variables:
      • HeaderId; integer; Value that uniquely identifies the sales order that contains the promotion linked with promotion code.
      • PromotionCode; string; Code is the mandatory qualifier for applying a promotion linked to the promotion code. The user must enter a predefined promo code on the sales order to qualify for the specific promotion.
    • findByPromocodeId: Finds promotion code according to promotion code identifier.
      Finder Variables:
      • PromocodeId; integer; Value that uniquely identifies the promotion code applied to the sales order.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • HeaderId; integer; Value that uniquely identifies the sales order that contains the promotion linked with promotion code.
    • PromocodeId; integer; Value that uniquely identifies the promotion code applied to the sales order.
    • PromotionCode; string; Mandatory qualifier for applying a promotion linked to the promotion code. The user must enter a predefined promo code on the sales order to qualify for the specific promotion.
    • Status; string; Status of the promo code application on the sales order.
    • StatusCode; string; Abbreviation that identifies the status of the promo code application on the sales order.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : salesOrdersForOrderHub-promotionCodes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : salesOrdersForOrderHub-promotionCodes-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the sales order that contains the promotion linked with promotion code.
  • Links
  • Read Only: true
    Value that uniquely identifies the promotion code applied to the sales order.
  • Maximum Length: 100
    Mandatory qualifier for applying a promotion linked to the promotion code. The user must enter a predefined promo code on the sales order to qualify for the specific promotion.
  • Read Only: true
    Maximum Length: 255
    Status of the promo code application on the sales order.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the status of the promo code application on the sales order.
Back to Top