Price Rule Detail

GET 
/openapi/2022-01/price_rules/:price_rule_id

Retrieves detailed information about a specific price rule based on its ID.

Request

Path Parameters

price_rule_id stringrequired

Price rule ID

Responses

200

200

application/json

Schema

Schema

price_rule object
idstring
Example: 00095d6a-419d-4499-a497-f265fb2edaa5
titlestring
Example: title-update
valueinteger
Default value: 0
Example: 0
value_typestring
Example: percentage
usage_limitstring
Example: -1
times_usedstring
Example: 0
allocation_methodstring
Example:
allocation_limitstring
Example: 0
once_per_customerstring
Example: 1
prerequisitestring
Example: 1
customer_selectionstring
Example: all
target_selectionstring
Example: entitled
target_typestring
Example:
created_atstring
Example: 2020-03-06 17:00:32
updated_atstring
Example: 2020-03-12 15:29:44
starts_atstring
Example: 1583424000
ends_atstring
Example: 1583942399
entitled_product_idsstring[]
entitled_variant_idsarray
prerequisite_quantity_range object[]
Array [
greater_than_or_equal_tostring
Example: 1
valuestring
Example: 5
target_typestring
Example:
target_dataarray
]
prerequisite_subtotal_range

Example

{
  "price_rule": {
    "id": "00095d6a-419d-4499-a497-f265fb2edaa5",
    "title": "title-update",
    "value": 0,
    "value_type": "percentage",
    "usage_limit": "-1",
    "times_used": "0",
    "allocation_method": "",
    "allocation_limit": "0",
    "once_per_customer": "1",
    "prerequisite": "1",
    "customer_selection": "all",
    "target_selection": "entitled",
    "target_type": "",
    "created_at": "2020-03-06 17:00:32",
    "updated_at": "2020-03-12 15:29:44",
    "starts_at": "1583424000",
    "ends_at": "1583942399",
    "entitled_product_ids": [
      "cea210d5-a419-4d4e-a17d-5bbd0bc4af76"
    ],
    "entitled_variant_ids": [
      null
    ],
    "prerequisite_quantity_range": [
      {
        "greater_than_or_equal_to": "1",
        "value": "5",
        "target_type": "",
        "target_data": [
          null
        ]
      }
    ],
    "prerequisite_subtotal_range": {}
  }
}

Result

{
    "price_rule": {
        "id": "00095d6a-419d-4499-a497-f265fb2edaa5",
        "title": "title-update",
        "value": 0,
        "value_type": "percentage",
        "usage_limit": "-1",
        "times_used": "0",
        "allocation_method": "",
        "allocation_limit": "0",
        "once_per_customer": "1",
        "prerequisite": "1",
        "customer_selection": "all",
        "target_selection": "entitled",
        "target_type": "",
        "created_at": "2020-03-06 17:00:32",
        "updated_at": "2020-03-12 15:29:44",
        "starts_at": "1583424000",
        "ends_at": "1583942399",
        "entitled_product_ids": [
            "cea210d5-a419-4d4e-a17d-5bbd0bc4af76",
            "de2c55f5-c3e1-45e1-92f6-e65faf816ecc",
            "47734e19-1b5c-468b-8695-31159d6d4478"
        ],
        "entitled_variant_ids": [],
        "prerequisite_quantity_range": [
            {
                "greater_than_or_equal_to": "1",
                "value": "5",
                "target_type": "",
                "target_data": []
            }
        ],
        "prerequisite_subtotal_range": null
    }
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Not found"
  ]
}

Result

{
    "errors": [
        "Not found"
    ]
}