Download OpenAPI specification:Download
API you can use to manage your Live Me Up resources
Create or Update a Product in your Live Me Up Catalog
| productId required | string (CatalogProductId) Example: 1212121 |
| x-request-id required | string <uuid> (RequestIdHeader) Example: 113492a9-dbd9-470b-a8e9-3cae659e0f3c A unique ID to pass for each request |
| description required | string must be between 5 and 2000 characters. If less, we will auto complete with "-" characters. If more, we will truncate. |
| id | string or null your internal product id. |
| images required | Array of strings <uri> [ items <uri > ] Default: [] |
| status required | string Default: "active" Enum: "active" "archived" Defines if the product must be visible in your Live Me Up catalog. "active": product is visible in the catalog and can be added in a live or in a shoppable. "archived": product won't be visible in the catalog anymore but is still visible (but not available to buy) in existing replays and shoppable videos. |
| title required | string must be between 3 and 60 characters. If less, we will auto complete with "-" characters. If more, we will truncate |
| crossedOutPrice required | number or null [ -9007199254740991 .. 9007199254740991 ] |
| inventoryPolicy required | string Default: "continue" Enum: "continue" "deny" Set to "continue" to continue to sell product when stock if empty |
| inventoryQuantity required | number [ -9007199254740991 .. 9007199254740991 ] Default: 0 The number of item in your stock. |
| price required | number [ -9007199254740991 .. 9007199254740991 ] |
| variants required | null |
Example of payload for a product without variant
{- "description": "our famous t-shirt",
- "id": "my-unique-product-id",
- "price": 25,
- "title": "T-Shirt"
}Example of response when payload does not have "price" property
{- "msg": "invalid payload.",
- "issues": [
- {
- "code": "invalid_type",
- "expected": "number",
- "received": "undefined",
- "path": [
- "price"
], - "message": "Required"
}
]
}Get displayed lives and replays
| x-livemeup-tenant-name required | string (TenantNameHeader) Example: shopname.myshopify.com The unique tenant name. For Shopify shops it is in the format of "shopname.myshopify.com" |
Example of a response when tenant display one upcoming live and two replays
{- "askEmail": true,
- "highlightedEvent": {
- "description": "Live Event Test",
- "id": "86ac818d-6eae-43c0-982e-d9c74200a230",
- "showTime": "2024-10-01T21:00:00.701Z",
- "status": "ON_AIR",
- "title": "Test1-Live"
}, - "publishedReplayEvents": [
- {
- "description": "asdasd",
- "id": "40ccc128-5bb5-49ef-8817-66a31d24832b",
- "showTime": "2024-09-26T08:37:57.000Z",
- "status": "REPLAY",
- "title": "mobile test"
}, - {
- "description": "Android Live Stream Test",
- "id": "9bd3a31b-94c1-43e4-ba3c-52787cd6d09f",
- "showTime": "2024-10-01T10:26:00.963Z",
- "status": "REPLAY",
- "title": "Android Event Test"
}
], - "replaySectionTitle": "Replays"
}