notifications
Update a notification
Changed onUpdate a notification
patch/notifications/{notificationId}
Request
- Base URLhttps://{your_organization_slug}.commercelayer.io/api
- URLhttps://{your_organization_slug}.commercelayer.io/api/notifications/{notificationId}
- AuthHTTP bearer
Path parameters
notificationIdstring required
The resource's id
Request body
Example request
{
"data": {
"id": "XAyRWNUzyN",
"attributes": {
"name": "DDT transport document",
"body": {
"sku": "REDHANDBAG",
"name": "Enjoy your free item"
},
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"notifiable": {
"data": {
"id": "XAyRWNUzyN",
"attributes": {
"sku_code": "TSHIRTMM000000FFFFFFXLXX",
"bundle_code": "BUNDLEMM000000FFFFFFXLXX",
"quantity": 4,
"_external_price": true,
"currency_code": "EUR",
"unit_amount_cents": 10000,
"unit_amount_float": 100,
"formatted_unit_amount": "€100,00",
"compare_at_amount_cents": 13000,
"compare_at_amount_float": 130,
"formatted_compare_at_amount": "€130,00",
"options_amount_cents": 1000,
"options_amount_float": 10,
"formatted_options_amount": "€10,00",
"discount_cents": -1000,
"discount_float": 10,
"formatted_discount": "€10,00",
"total_amount_cents": 18800,
"total_amount_float": 188,
"formatted_total_amount": "€188,00",
"tax_amount_cents": 1880,
"tax_amount_float": 18.8,
"formatted_tax_amount": "€18,80",
"name": "Men's Black T-shirt with White Logo (XL)",
"image_url": "https://img.yourdomain.com/skus/xYZkjABcde.png",
"discount_breakdown": {
"41": {
"name": "10% ALL",
"cents": -900,
"weight": 0.416,
"coupon_code": "XXXXXXXX"
}
},
"tax_rate": 0.22,
"tax_breakdown": {
"id": "1234",
"city_amount": "0.0",
"state_amount": 6.6,
"city_tax_rate": 0,
"county_amount": 2.78,
"taxable_amount": 139,
"county_tax_rate": 0.02,
"tax_collectable": 10.08,
"special_tax_rate": 0.005,
"combined_tax_rate": 0.0725,
"city_taxable_amount": 0,
"state_sales_tax_rate": 0.0475,
"state_taxable_amount": 139,
"county_taxable_amount": 139,
"special_district_amount": 0.7,
"special_district_taxable_amount": 139
},
"item_type": "skus",
"frequency": "monthly",
"coupon_code": "SUMMERDISCOUNT",
"circuit_state": "closed",
"circuit_failure_count": 5,
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"order": {
"data": {
"id": "XAyRWNUzyN"
}
},
"item": {
"data": {
"id": "XAyRWNUzyN",
"attributes": {
"code": "TSHIRTMM000000FFFFFFXLXX",
"name": "Men's Black T-shirt with White Logo (XL)",
"description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"image_url": "https://img.yourdomain.com/skus/xYZkjABcde.png",
"pieces_per_pack": 6,
"weight": 300,
"unit_of_weight": "gr",
"hs_tariff_number": "4901.91.0020",
"inventory": {
"available": true,
"quantity": 10,
"levels": [
{
"quantity": 4,
"delivery_lead_times": [
{
"shipping_method": {
"name": "Standard Shipping",
"reference": null,
"price_amount_cents": 700,
"free_over_amount_cents": 9900,
"formatted_price_amount": "€7,00",
"formatted_free_over_amount": "€99,00"
},
"min": {
"hours": 72,
"days": 3
},
"max": {
"hours": 120,
"days": 5
}
},
{
"shipping_method": {
"name": "Express Delivery",
"reference": null,
"price_amount_cents": 1200,
"free_over_amount_cents": null,
"formatted_price_amount": "€12,00",
"formatted_free_over_amount": null
},
"min": {
"hours": 48,
"days": 2
},
"max": {
"hours": 72,
"days": 3
}
}
]
},
{
"quantity": 6,
"delivery_lead_times": [
{
"shipping_method": {
"name": "Standard Shipping",
"reference": null,
"price_amount_cents": 700,
"free_over_amount_cents": 9900,
"formatted_price_amount": "€7,00",
"formatted_free_over_amount": "€99,00"
},
"min": {
"hours": 96,
"days": 4
},
"max": {
"hours": 144,
"days": 6
}
},
{
"shipping_method": {
"name": "Express Delivery",
"reference": null,
"price_amount_cents": 1200,
"free_over_amount_cents": null,
"formatted_price_amount": "€12,00",
"formatted_free_over_amount": null
},
"min": {
"hours": 72,
"days": 3
},
"max": {
"hours": 96,
"days": 4
}
}
]
}
]
},
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"jwt_custom_claim": {},
"metadata": {
"foo": "bar"
}
},
"relationships": {
"shipping_category": {
"data": {
"id": "XAyRWNUzyN"
}
},
"prices": {
"data": {
"id": "XAyRWNUzyN"
}
},
"stock_items": {
"data": {
"id": "XAyRWNUzyN"
}
},
"stock_reservations": {
"data": {
"id": "XAyRWNUzyN"
}
},
"delivery_lead_times": {
"data": {
"id": "XAyRWNUzyN"
}
},
"sku_options": {
"data": {
"id": "XAyRWNUzyN"
}
},
"sku_list_items": {
"data": {
"id": "XAyRWNUzyN"
}
},
"sku_lists": {
"data": {
"id": "XAyRWNUzyN"
}
},
"attachments": {
"data": {
"id": "XAyRWNUzyN"
}
},
"links": {
"data": {
"id": "XAyRWNUzyN"
}
},
"events": {
"data": {
"id": "XAyRWNUzyN"
}
},
"tags": {
"data": {
"id": "XAyRWNUzyN"
}
},
"jwt_customer": {
"data": {
"id": "XAyRWNUzyN"
}
},
"jwt_markets": {
"data": {
"id": "XAyRWNUzyN"
}
},
"jwt_stock_locations": {
"data": {
"id": "XAyRWNUzyN"
}
},
"event_stores": {
"data": {
"id": "XAyRWNUzyN"
}
}
}
}
},
"sku": {
"data": {
"id": "XAyRWNUzyN"
}
},
"bundle": {
"data": {
"id": "XAyRWNUzyN"
}
},
"adjustment": {
"data": {
"id": "XAyRWNUzyN"
}
},
"gift_card": {
"data": {
"id": "XAyRWNUzyN"
}
},
"shipment": {
"data": {
"id": "XAyRWNUzyN"
}
},
"payment_method": {
"data": {
"id": "XAyRWNUzyN"
}
},
"line_item_options": {
"data": {
"id": "XAyRWNUzyN"
}
},
"return_line_items": {
"data": {
"id": "XAyRWNUzyN"
}
},
"shipment_line_items": {
"data": {
"id": "XAyRWNUzyN"
}
},
"stock_reservations": {
"data": {
"id": "XAyRWNUzyN"
}
},
"stock_line_items": {
"data": {
"id": "XAyRWNUzyN"
}
},
"stock_transfers": {
"data": {
"id": "XAyRWNUzyN"
}
},
"attachments": {
"data": {
"id": "XAyRWNUzyN"
}
},
"notifications": {
"data": {
"id": "XAyRWNUzyN"
}
},
"events": {
"data": {
"id": "XAyRWNUzyN"
}
},
"tags": {
"data": {
"id": "XAyRWNUzyN"
}
},
"event_stores": {
"data": {
"id": "XAyRWNUzyN"
}
}
}
}
}
}
}
}Response
The updated notification object
Changes
- info
added the new optional request property
////////////////
- info
- info
added the new optional request property
///////// - info
request property
////////////////reactivated - info
request property
/////////reactivated
- info