Jump to

• Request
• Response

Create one promotion code

post

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

Request

Path Parameters

• OrderKey(required): string
  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.

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

• PromotionCode: string
  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.

{
    "type":"object",
    "properties":{
        "PromotionCode":{
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "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 : salesOrdersForOrderHub-promotionCodes-item-response

Type: object

Show Source

• HeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sales order that contains the promotion linked with promotion code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PromocodeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the promotion code applied to the sales order.
• PromotionCode: string
  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.
• Status: string
  Read Only: true

  Maximum Length: 255

  Status of the promo code application on the sales order.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the promo code application on the sales order.

{
    "type":"object",
    "properties":{
        "PromocodeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the promotion code applied to the sales order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the promo code application on the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order that contains the promotion linked with promotion code.",
            "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"
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the promo code application on the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionCode":{
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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