Medusa

Get a Condition

GET

/admin/discounts/{discount_id}/conditions/{condition_id}

Discounts

Retrieve a Discount Condition's details.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/admin/discounts//conditions/'

Response Example

200 - Example 1

{
  "discount_condition": {
    "id": "discon_01G8X9A7ESKAJXG2H0E6F1MW7A",
    "discount_rule_id": "dru_01F0YESMVK96HVX7N419E3CJ7C",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "type": "products",
    "operator": "in",
    "metadata": {
      "car": "white"
    },
    "discount_rule": {
      "id": "dru_01F0YESMVK96HVX7N419E3CJ7C",
      "description": "10 Percent",
      "value": 10,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "type": "fixed",
      "allocation": "total",
      "conditions": [
        {}
      ],
      "metadata": {
        "car": "white"
      }
    },
    "product_tags": [
      {
        "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
        "value": "Pants",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        }
      }
    ],
    "customer_groups": [
      {
        "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
        "name": "VIP",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "customers": [
          {}
        ],
        "price_lists": [
          {}
        ],
        "metadata": {
          "car": "white"
        }
      }
    ],
    "product_collections": [
      {
        "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
        "title": "Summer Collection",
        "handle": "summer-collection",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "products": [
          {}
        ],
        "metadata": {
          "car": "white"
        }
      }
    ],
    "product_types": [
      {
        "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "value": "Clothing",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
          "car": "white"
        }
      }
    ],
    "products": [
      {
        "id": "prod_01G1G5V2MBA328390B5AXJ610F",
        "title": "Medusa Coffee Mug",
        "subtitle": "string",
        "description": "Every programmer's best friend.",
        "handle": "coffee-mug",
        "is_giftcard": false,
        "thumbnail": "http://example.com",
        "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
        "weight": null,
        "length": null,
        "height": null,
        "width": null,
        "hs_code": null,
        "origin_country": null,
        "mid_code": null,
        "material": null,
        "collection_id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
        "type_id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "discountable": true,
        "external_id": null,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "status": "draft",
        "metadata": {
          "car": "white"
        },
        "images": [
          {
            "id": "img_01G749BFYR6T8JTVW6SGW3K3E6",
            "url": "http://example.com",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            }
          }
        ],
        "categories": [
          {
            "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
            "name": "Regular Fit",
            "handle": "regular-fit",
            "mpath": "pcat_id1.pcat_id2.pcat_id3",
            "is_internal": false,
            "is_active": false,
            "rank": 0,
            "parent_category_id": null,
            "parent_category": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "category_children": [
              {}
            ],
            "products": [
              {}
            ]
          }
        ],
        "collection": {
          "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
          "title": "Summer Collection",
          "handle": "summer-collection",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z",
          "products": [
            {}
          ],
          "metadata": {
            "car": "white"
          }
        },
        "tags": [
          {
            "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
            "value": "Pants",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            }
          }
        ],
        "profile": {
          "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
          "name": "Default Shipping Profile",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z",
          "type": "default",
          "products": [
            {}
          ],
          "shipping_options": [
            {}
          ],
          "metadata": {
            "car": "white"
          }
        },
        "profiles": [
          {
            "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
            "name": "Default Shipping Profile",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "type": "default",
            "products": [
              {}
            ],
            "shipping_options": [
              {}
            ],
            "metadata": {
              "car": "white"
            }
          }
        ],
        "type": {
          "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
          "value": "Clothing",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z",
          "metadata": {
            "car": "white"
          }
        },
        "sales_channels": [
          {
            "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "name": "Market",
            "description": "Multi-vendor market",
            "is_disabled": false,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            },
            "locations": [
              {
                "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                "location_id": "string",
                "sales_channel": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z"
              }
            ]
          }
        ],
        "options": [
          {
            "id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
            "title": "Size",
            "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
            "product": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
              "car": "white"
            },
            "values": [
              {
                "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                "value": "large",
                "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                "option": {},
                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                "variant": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {
                  "car": "white"
                }
              }
            ]
          }
        ],
        "variants": [
          {
            "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
            "title": "Small",
            "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
            "product": {},
            "sku": "shirt-123",
            "barcode": null,
            "ean": null,
            "upc": null,
            "variant_rank": 0,
            "inventory_quantity": 100,
            "allow_backorder": false,
            "manage_inventory": true,
            "hs_code": null,
            "origin_country": null,
            "mid_code": null,
            "material": null,
            "weight": null,
            "length": null,
            "height": null,
            "width": null,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "purchasable": true,
            "metadata": {
              "car": "white"
            },
            "options": [
              {
                "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                "value": "large",
                "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                "option": {},
                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                "variant": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {
                  "car": "white"
                }
              }
            ],
            "inventory_items": [
              {
                "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A",
                "inventory_item_id": "string",
                "variant_id": "string",
                "variant": {},
                "required_quantity": 1,
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z"
              }
            ],
            "prices": [
              {
                "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
                "amount": 100,
                "min_quantity": 1,
                "max_quantity": 1,
                "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
                "price_list": {},
                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                "variant": {},
                "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                "region": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "currency_code": "usd",
                "currency": {
                  "symbol": "$",
                  "symbol_native": "$",
                  "name": "US Dollar",
                  "includes_tax": false,
                  "code": "usd"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

Request

Path Params

discount_id

string

required

The ID of the Discount.

condition_id

string

required

The ID of the Discount Condition.

Query Params

expand

string

optional

Comma-separated relations that should be expanded in the returned discount condition.

fields

string

optional

Comma-separated fields that should be included in the returned discount condition.

Responses

🟢200OK

application/json

Body

discount_condition

object (Discount Condition)

required

Holds rule conditions for when a discount is applicable

string

required

The discount condition's ID

Example:

discon_01G8X9A7ESKAJXG2H0E6F1MW7A

discount_rule_id

string

required

The ID of the discount rule associated with the condition

Example:

dru_01F0YESMVK96HVX7N419E3CJ7C

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

type

enum<string>

required

The type of the condition. The type affects the available resources associated with the condition. For example, if the type is products, that means the products relation will hold the products associated with this condition and other relations will be empty.

Allowed values:

productsproduct_typesproduct_collectionsproduct_tagscustomer_groups

operator

enum<string>

required

The operator of the condition. in indicates that discountable resources are within the specified resources. not_in indicates that discountable resources are everything but the specified resources.

Allowed values:

innot_in

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

discount_rule

object (Discount Rule)

optional

A discount rule defines how a Discount is calculated when applied to a Cart.

product_tags

array[object (Product Tag) {6}]

optional

Product tags associated with this condition if type is product_tags.

customer_groups

array[object (Customer Group) {8}]

optional

Customer groups associated with this condition if type is customer_groups.

product_collections

array[object (Product Collection) {8}]

optional

Product collections associated with this condition if type is product_collections.

product_types

array[object (Product Type) {6}]

optional

Product types associated with this condition if type is product_types.

products

array[object (Product) {35}]

optional

products associated with this condition if type is products.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2023-10-10 11:56:36

List Discounts

Update a Condition