REST API
Search…
⌃K

Channels

Find all channels
Outshifter has various integrations to different kinds of channels. This endpoint provides a list of them, differentiating whether they are currently enabled or not.
It is through channels sellers can export and sell products on their own surface. Plug & Play options include Shopify, WooCommerce, Magento, Vev and Wordpress. You can, however, use the API to create your own experience and use case..
get
https://api.outshifter.com/api
/channels
Find all channels
Response Example:
[
{
"id": 1,
"name": "Outshifter",
"enabled": false
},
{
"id": 2,
"name": "Shopify",
"enabled": true
},
{
"id": 3,
"name": "Facebook",
"enabled": false
},
{
"id": 4,
"name": "Instagram",
"enabled": false
},
{
"id": 5,
"name": "Woocommerce",
"enabled": true
},
{
"id": 6,
"name": "Squarespace",
"enabled": true
}
]
get
https://api.outshifter.com/api
/channel
Find all channels
Response Example:
{
"channels": [
{
"createdAt": "2022-10-14T14:24:24.044Z",
"updatedAt": "2022-10-14T14:24:24.322Z",
"deletedAt": null,
"id": 2,
"name": "Shopify",
"enabled": true
},
{
"createdAt": "2022-10-14T14:24:24.044Z",
"updatedAt": "2022-10-14T14:24:24.322Z",
"deletedAt": null,
"id": 5,
"name": "Woocommerce",
"enabled": true
},
{
"createdAt": "2022-10-14T14:24:24.044Z",
"updatedAt": "2022-10-14T14:24:24.322Z",
"deletedAt": null,
"id": 6,
"name": "Squarespace",
"enabled": true
},
{
"createdAt": "2022-10-24T15:37:45.121Z",
"updatedAt": "2022-10-24T15:38:07.214Z",
"deletedAt": null,
"id": 7,
"name": "Wordpress",
"enabled": true
},
{
"createdAt": "2022-10-28T12:31:14.322Z",
"updatedAt": "2022-10-28T12:31:14.322Z",
"deletedAt": null,
"id": 8,
"name": "Vev",
"enabled": true
}
],
"total": 5
}
get
https://api.outshifter.com/api
/channel/:id
Get channel by Id
Response Example:
{
"createdAt": "2022-10-14T14:24:24.044Z",
"updatedAt": "2022-10-14T14:24:24.322Z",
"deletedAt": null,
"id": 2,
"name": "Shopify",
"enabled": true
}
get
https://api.outshifter.com/api
/channel/user/:id
Get channels from user
Response Example:
[
{
"createdAt": "2022-10-27T14:43:38.885Z",
"updatedAt": "2022-10-27T14:43:38.885Z",
"deletedAt": null,
"id": 28,
"channel": {
"id": 7,
"name": "Wordpress"
},
"totalCollections": 5,
"totalProducts": 2,
"totalVariants": 0,
"totalCollectionsShared": 2
}
]
post
https://api.outshifter.com/api
/channel/user
Join channel to user
Body Example:
{
"channel_id": 2
}
Response Example:
{
"user": {
"id": 612,
"username": "BrandSupplier",
"name": "Brand",
"surname": "Supplier",
"avatar": "https://outshifter-uploads.s3.us-east-2.amazonaws.com/default-placeholder.png"
},
"channel": {
"id": 2,
"name": "Shopify"
},
"deletedAt": null,
"createdAt": "2022-10-28T14:35:07.594Z",
"updatedAt": "2022-10-28T14:35:07.594Z",
"id": 33
}
get
https://api.outshifter.com/api
/channel/user/bychannelid/:id
Get items joined to channel
Response Example:
{
"createdAt": "2022-10-27T14:43:38.885Z",
"updatedAt": "2022-10-27T14:43:38.885Z",
"deletedAt": null,
"id": 28,
"channel": {
"id": 7,
"name": "Wordpress"
},
"collections": [
{
"createdAt": "2022-10-27T11:49:02.064Z",
"updatedAt": "2022-10-28T07:45:10.000Z",
"id": "1Yspzde5A",
"deletedAt": null,
"title": "colletion 2",
"description": "afjhghdjkafewtwrg",
"slug": null,
"image": "https://outshifter-uploads-qa.s3.eu-central-1.amazonaws.com/product-images/collection-64170b4d-1fd1-4a7f-be97-cfbef02d7621.jpeg",
"items": [
{
"createdAt": "2022-10-27T11:49:16.421Z",
"updatedAt": "2022-10-27T11:49:16.421Z",
"id": 310,
"deletedAt": null,
"variantId": null,
"product": {
"createdAt": "2022-10-27T11:39:54.550Z",
"updatedAt": "2022-10-27T11:45:45.000Z",
"id": 4714,
"deletedAt": null,
"title": "White Cotton Shirt",
"status": 1,
"description": "<p>Plain white cotton long sleeved shirt with loose collar. Small buttons and front pocket.</p>",
"publicPrice": "100.00",
"referralFee": 10,
"tags": "",
"sku": "OHD11JKHKUTTH7LE",
"barcode": null,
"quantity": 100,
"allowPurchaseOutOfStock": false,
"weight": "1.00",
"shipTo": null,
"width": null,
"height": null,
"depth": null,
"optionsEnabled": false,
"origin": "SHOPIFY",
"originId": "7973890752787",
"originVariantId": "43675047264531",
"rate": 0,
"migrated": false,
"price": {
"amount": null,
"currencyCode": null
},
"images": [
{
"id": 17123,
"deletedAt": null,
"url": "https://cdn.shopify.com/s/files/1/0671/7069/7491/products/smiling-woman-poses_925x_a326ce58-9c97-4cfc-b5e7-13250ebd4d0c.jpg?v=1666869994",
"width": 925,
"height": 617,
"order": 0
}
],
"variants": [],
"revenue": 90
}
},
{
"createdAt": "2022-10-27T11:49:16.437Z",
"updatedAt": "2022-10-27T11:49:16.437Z",
"id": 314,
"deletedAt": null,
"variantId": null,
"product": {
"createdAt": "2022-10-27T11:39:54.566Z",
"updatedAt": "2022-10-27T11:45:44.000Z",
"id": 4715,
"deletedAt": null,
"title": "LED High Tops",
"status": 1,
"description": "<p>Black high top shoes with green LED lights in the sole, tied up with laces and a buckle.</p>",
"publicPrice": "100.00",
"referralFee": 10,
"tags": "",
"sku": "FOJUXUG5PHBOXUSH",
"barcode": null,
"quantity": 100,
"allowPurchaseOutOfStock": false,
"weight": "1.00",
"shipTo": null,
"width": null,
"height": null,
"depth": null,
"optionsEnabled": false,
"origin": "SHOPIFY",
"originId": "7973890425107",
"originVariantId": "43675046936851",
"rate": 0,
"migrated": false,
"price": {
"amount": null,
"currencyCode": null
},
"images": [
{
"id": 17124,
"deletedAt": null,
"url": "https://cdn.shopify.com/s/files/1/0671/7069/7491/products/putting-on-your-shoes_925x_94c25265-e8ab-4bd5-8a15-d8043ba01bff.jpg?v=1666869979",
"width": 925,
"height": 617,
"order": 0
}
],
"variants": [],
"revenue": 90
}
}
]
}
}
]
},
get
https://api.outshifter.com/api
/channel/all-by-user/:id
Get items joined to all channels
Response Example:
{
"createdAt": "2022-10-27T14:43:38.885Z",
"updatedAt": "2022-10-27T14:43:38.885Z",
"deletedAt": null,
"id": 28,
"channel": {
"id": 7,
"name": "Wordpress"
},
"collections": [
{
"createdAt": "2022-10-27T11:49:02.064Z",
"updatedAt": "2022-10-28T07:45:10.000Z",
"id": "1Yspzde5A",
"deletedAt": null,
"title": "colletion 2",
"description": "afjhghdjkafewtwrg",
"slug": null,
"image": "https://outshifter-uploads-qa.s3.eu-central-1.amazonaws.com/product-images/collection-64170b4d-1fd1-4a7f-be97-cfbef02d7621.jpeg",
"items": [
{
"createdAt": "2022-10-27T11:49:16.421Z",
"updatedAt": "2022-10-27T11:49:16.421Z",
"id": 310,
"deletedAt": null,
"variantId": null,
"product": {
"createdAt": "2022-10-27T11:39:54.550Z",
"updatedAt": "2022-10-27T11:45:45.000Z",
"id": 4714,
"deletedAt": null,
"title": "White Cotton Shirt",
"status": 1,
"description": "<p>Plain white cotton long sleeved shirt with loose collar. Small buttons and front pocket.</p>",
"publicPrice": "100.00",
"referralFee": 10,
"tags": "",
"sku": "OHD11JKHKUTTH7LE",
"barcode": null,
"quantity": 100,
"allowPurchaseOutOfStock": false,
"weight": "1.00",
"shipTo": null,
"width": null,
"height": null,
"depth": null,
"optionsEnabled": false,
"origin": "SHOPIFY",
"originId": "7973890752787",
"originVariantId": "43675047264531",
"rate": 0,
"migrated": false,
"price": {
"amount": null,
"currencyCode": null
},
"images": [
{
"id": 17123,
"deletedAt": null,
"url": "https://cdn.shopify.com/s/files/1/0671/7069/7491/products/smiling-woman-poses_925x_a326ce58-9c97-4cfc-b5e7-13250ebd4d0c.jpg?v=1666869994",
"width": 925,
"height": 617,
"order": 0
}
],
"variants": [],
"revenue": 90
}
},
{
"createdAt": "2022-10-27T11:49:16.437Z",
"updatedAt": "2022-10-27T11:49:16.437Z",
"id": 314,
"deletedAt": null,
"variantId": null,
"product": {
"createdAt": "2022-10-27T11:39:54.566Z",
"updatedAt": "2022-10-27T11:45:44.000Z",
"id": 4715,
"deletedAt": null,
"title": "LED High Tops",
"status": 1,
"description": "<p>Black high top shoes with green LED lights in the sole, tied up with laces and a buckle.</p>",
"publicPrice": "100.00",
"referralFee": 10,
"tags": "",
"sku": "FOJUXUG5PHBOXUSH",
"barcode": null,
"quantity": 100,
"allowPurchaseOutOfStock": false,
"weight": "1.00",
"shipTo": null,
"width": null,
"height": null,
"depth": null,
"optionsEnabled": false,
"origin": "SHOPIFY",
"originId": "7973890425107",
"originVariantId": "43675046936851",
"rate": 0,
"migrated": false,
"price": {
"amount": null,
"currencyCode": null
},
"images": [
{
"id": 17124,
"deletedAt": null,
"url": "https://cdn.shopify.com/s/files/1/0671/7069/7491/products/putting-on-your-shoes_925x_94c25265-e8ab-4bd5-8a15-d8043ba01bff.jpg?v=1666869979",
"width": 925,
"height": 617,
"order": 0
}
],
"variants": [],
"revenue": 90
}
}
]
}
}
]
},
{
"createdAt": "2022-10-28T14:35:07.594Z",
"updatedAt": "2022-10-28T14:35:07.594Z",
"deletedAt": null,
"id": 33,
"channel": {
"id": 2,
"name": "Shopify"
},
"collections": [],
"variants": [],
"products": [],
"collectionsShared": []
}
post
https://api.outshifter.com/api
/channel/group
Add item to channel joined to user
Body Example:
{
"user_id": 612,
"channel_id": 7,
"product_id": 4714,
"collection_id": "1Yspzde5A"
}
Response Example:
{
"id": 7,
"channel": "Wordpress",
"collections": [
{
"createdAt": "2022-10-27T11:49:02.064Z",
"updatedAt": "2022-10-28T07:45:10.000Z",
"id": "1Yspzde5A",
"deletedAt": null,
"title": "colletion 2",
"description": "afjhghdjkafewtwrg",
"slug": null,
"image": "https://outshifter-uploads-qa.s3.eu-central-1.amazonaws.com/product-images/collection-64170b4d-1fd1-4a7f-be97-cfbef02d7621.jpeg",
"items": [
{
"createdAt": "2022-10-27T11:49:16.421Z",
"updatedAt": "2022-10-27T11:49:16.421Z",
"id": 310,
"deletedAt": null,
"variantId": null,
"product": {
"createdAt": "2022-10-27T11:39:54.550Z",
"updatedAt": "2022-10-27T11:45:45.000Z",
"id": 4714,
"deletedAt": null,
"title": "White Cotton Shirt",
"status": 1,
"description": "<p>Plain white cotton long sleeved shirt with loose collar. Small buttons and front pocket.</p>",
"publicPrice": "100.00",
"referralFee": 10,
"tags": "",
"sku": "OHD11JKHKUTTH7LE",
"barcode": null,
"quantity": 100,
"allowPurchaseOutOfStock": false,
"weight": "1.00",
"shipTo": null,
"width": null,
"height": null,
"depth": null,
"optionsEnabled": false,
"origin": "SHOPIFY",
"originId": "7973890752787",
"originVariantId": "43675047264531",
"rate": 0,
"migrated": false,
"price": {
"amount": null,
"currencyCode": null
},
"images": [
{
"id": 17123,
"deletedAt": null,
"url": "https://cdn.shopify.com/s/files/1/0671/7069/7491/products/smiling-woman-poses_925x_a326ce58-9c97-4cfc-b5e7-13250ebd4d0c.jpg?v=1666869994",
"width": 925,
"height": 617,
"order": 0
}
],
"variants": [],
"revenue": 90
}
},
{
"createdAt": "2022-10-27T11:49:16.437Z",
"updatedAt": "2022-10-27T11:49:16.437Z",
"id": 314,
"deletedAt": null,
"variantId": null,
"product": {
"createdAt": "2022-10-27T11:39:54.566Z",
"updatedAt": "2022-10-27T11:45:44.000Z",
"id": 4715,
"deletedAt": null,
"title": "LED High Tops",
"status": 1,
"description": "<p>Black high top shoes with green LED lights in the sole, tied up with laces and a buckle.</p>",
"publicPrice": "100.00",
"referralFee": 10,
"tags": "",
"sku": "FOJUXUG5PHBOXUSH",
"barcode": null,
"quantity": 100,
"allowPurchaseOutOfStock": false,
"weight": "1.00",
"shipTo": null,
"width": null,
"height": null,
"depth": null,
"optionsEnabled": false,
"origin": "SHOPIFY",
"originId": "7973890425107",
"originVariantId": "43675046936851",
"rate": 0,
"migrated": false,
"price": {
"amount": null,
"currencyCode": null
},
"images": [
{
"id": 17124,
"deletedAt": null,
"url": "https://cdn.shopify.com/s/files/1/0671/7069/7491/products/putting-on-your-shoes_925x_94c25265-e8ab-4bd5-8a15-d8043ba01bff.jpg?v=1666869979",
"width": 925,
"height": 617,
"order": 0
}
],
"variants": [],
"revenue": 90
}
}
]
}
}
]
}
delete
https://api.outshifter.com/api
/channel/:id
Delete channel joined to user
Response Example:
{
"status": 200,
"message": "Channel: Shopify from User: 612 and 0 Channel groups were deleted."
}
delete
https://api.outshifter.com/api
/channel/group/delete
Delete multiple items joined to user's channel
get
https://api.outshifter.com/api
/channel/all-items/user
Get all items
post
https://api.outshifter.com/api
/user-channel-api-key
Create API Key
Body Example:
{
"user_id": 615,
"channel_id": 5
}
Response Example:
{
"channel": {
"createdAt": "2022-10-14T14:24:24.044Z",
"updatedAt": "2022-10-14T14:24:24.322Z",
"deletedAt": null,
"id": 5,
"name": "Woocommerce",
"enabled": true
},
"apiKey": "SX2E20C-0MJMGHG-ME53FAD-QMTW5R5",
"deletedAt": null,
"createdAt": "2022-10-28T15:22:28.727Z",
"updatedAt": "2022-10-28T15:22:28.727Z",
"id": 8
}
get
https://api.outshifter.com/api
/user-channel-api-key
Get API Key from user
delete
https://api.outshifter.com/api
/user-channel-api-key
Delete API key from user