REST API
Search…
⌃K

Collections

A collection is a grouping of products merchants can create to make it easier to share your products with other merchants or apps. For example, a merchant might create a collection for a specific type of product that they want to share, such as the Winter collection. Merchants can create collections by selecting products individually.
Outshifter create a default collection with all your products called All my products.
Interact with ColGet products by user.

Collection Endpoints

Create Collection

Create a custom collection with customized details. Choose your own title, add a description and finish by incorporating an image to your collection.
post
https://api.outshifter.com/api
/collection
Create collection
Body example:
{
"title": "Test Collection",
"description": "This is just a test collection",
"slug":"TestCollection",
"iamge":"https://img.freepik.com/free-photo/man-with-sunglasses-wearing-white-t-shirt-posing_158538-16721.jpg?w=1380&t=st=1664538762~exp=1664539362~hmac=6d28be6fc377a0f7a1364cff4e8a22cb02ff51d2b0284b9a27e2f6ba6fce40b7"
}
Response example:
{
"createdAt": "2022-10-03T10:22:23.661Z",
"updatedAt": "2022-10-03T10:22:23.661Z",
"id": "tPlUqJlLy",
"deletedAt": null,
"title": "Test Collection",
"description": "This is just a test collection",
"slug": "TestCollection",
"image": null,
"items": [],
"user": {
"id": 239
}
}

Delete Collection

In case you need to delete a collection, it is possible via this endpoint.
delete
https://api.outshifter.com/api
/collection
Delete collection by id
Body example:
{
"collection_id": "OnMymuvId"
}
Response example:
{
"message": "Collection tPlUqJlLy was deleted.",
"status": 200
}

Update Collection

You also have the possibility of making an update in your collection, either to change the title or the image of it.
put
https://api.outshifter.com/api
/collection
Update collection by id
Body example:
{
"collection_id":"OnMymuvId",
"title": "Test Collection N1",
"description": "This is just a test collection",
"slug":"TestCollectionN1",
"image":"https://img.freepik.com/free-photo/man-with-sunglasses-wearing-white-t-shirt-posing_158538-16721.jpg?w=1380&t=st=1664538762~exp=1664539362~hmac=6d28be6fc377a0f7a1364cff4e8a22cb02ff51d2b0284b9a27e2f6ba6fce40b7"
}

Get collection by ID

You can retrieve information of a specific collection using the following endpoint.
get
https://api.outshifter.com/api
/collection/:id
Get collection by id
Response example:
{
"createdAt": "2022-09-30T12:28:36.766Z",
"updatedAt": "2022-09-30T12:31:41.000Z",
"id": "ONVV41Xei",
"deletedAt": null,
"title": "Test Collection 111",
"description": "This is just a test collection",
"slug": "TestCollection",
"image": null,
"items": [],
"user": {
"id": 239
}
}

Get collection by logged user

You can retrieve information from all collections created by a user using the following endpoint.
get
https://api.outshifter.com/api
/collection
Get all collection by logged user
Response example:
{
"collections": [
{
"createdAt": "2022-09-30T14:20:26.672Z",
"updatedAt": "2022-09-30T14:20:26.672Z",
"id": "CPa_Uquhc",
"deletedAt": null,
"title": "Test Collection",
"description": "This is just a test collection",
"slug": "TestCollection",
"image": null,
"totalItems": 2
},
{
"createdAt": "2022-09-30T13:10:34.379Z",
"updatedAt": "2022-09-30T14:10:04.000Z",
"id": "Dz5khk_xi",
"deletedAt": null,
"title": "Lala Oh Yeah Modified",
"description": "New description",
"slug": null,
"image": null,
"totalItems": 0
},
{
"createdAt": "2022-09-30T13:38:22.537Z",
"updatedAt": "2022-09-30T13:38:22.537Z",
"id": "EoYVrbr9K",
"deletedAt": null,
"title": "The Collection",
"description": null,
"slug": null,
"image": null,
"totalItems": 0
},
{
"createdAt": "2022-09-30T12:28:36.766Z",
"updatedAt": "2022-09-30T12:31:41.000Z",
"id": "ONVV41Xei",
"deletedAt": null,
"title": "Test Collection 111",
"description": "This is just a test collection",
"slug": "TestCollection",
"image": null,
"totalItems": 0
},
{
"createdAt": "2022-09-30T12:36:48.501Z",
"updatedAt": "2022-09-30T12:36:48.501Z",
"id": "prZzewiNw",
"deletedAt": null,
"title": "Testing on App",
"description": "Testing on App description",
"slug": null,
"image": null,
"totalItems": 0
},
{
"createdAt": "2022-09-30T09:48:12.073Z",
"updatedAt": "2022-09-30T09:48:12.073Z",
"id": "RfbnJu5Zo",
"deletedAt": null,
"title": "Testing a new collection 2",
"description": null,
"slug": null,
"image": null,
"totalItems": 0
},
{
"createdAt": "2022-09-30T12:52:18.615Z",
"updatedAt": "2022-09-30T12:52:18.615Z",
"id": "STw3u7-hD",
"deletedAt": null,
"title": "Lalo Landa",
"description": null,
"slug": null,
"image": null,
"totalItems": 0
},
{
"createdAt": "2022-09-30T13:13:28.430Z",
"updatedAt": "2022-09-30T13:13:28.430Z",
"id": "taNoHBwG4",
"deletedAt": null,
"title": "One day more",
"description": null,
"slug": null,
"image": null,
"totalItems": 0
},
{
"createdAt": "2022-09-30T12:50:08.706Z",
"updatedAt": "2022-09-30T12:50:08.706Z",
"id": "uuJlCbqJf",
"deletedAt": null,
"title": "My Perfect Collection",
"description": "dsadasdasdsa",
"slug": null,
"image": null,
"totalItems": 0
},
{
"createdAt": "2022-09-30T09:36:59.460Z",
"updatedAt": "2022-09-30T09:36:59.460Z",
"id": "ZsnCOC-OX",
"deletedAt": null,
"title": "Testing a new collection",
"description": null,
"slug": null,
"image": null,
"totalItems": 0
}
],
"totalCollections": 10
}

Get collection by user id

Get information of the collections of a user using this endpoint and the Outshifter ID of the specific user.
get
https://api.outshifter.com/api
/collection/user/:id
Get collection by user id

Collection Items Endpoints

Add item

Add an additional item o multiple items to the collection.
It is possible to add more than one item on this endpoint.
post
https://api.outshifter.com/api
/collection/item/add
Add item to collection
Body example:
{
"collection_id":"CPa_Uquhc",
"product_id": 4406
}
Response example:
{
"createdAt": "2022-09-30T14:20:26.672Z",
"updatedAt": "2022-09-30T14:20:26.672Z",
"id": "CPa_Uquhc",
"deletedAt": null,
"title": "Test Collection",
"description": "This is just a test collection",
"slug": "TestCollection",
"image": null,
"items": [
{
"createdAt": "2022-09-30T14:20:42.965Z",
"updatedAt": "2022-09-30T14:20:42.965Z",
"id": 28,
"deletedAt": null,
"variantId": null,
"product": {
"createdAt": "2022-09-30T12:44:24.634Z",
"updatedAt": "2022-09-30T12:45:58.000Z",
"id": 4406,
"deletedAt": null,
"title": "Sunglasses Flow Bacano",
"status": 1,
"description": "<p>Sunglasses with a Bacano Flow</p>",
"publicPrice": "430.00",
"referralFee": 20,
"tags": "",
"sku": "CWXHWTHFNGT1SLMW",
"barcode": "",
"quantity": 90,
"allowPurchaseOutOfStock": false,
"weight": "2.50",
"shipTo": null,
"width": "10.00",
"height": "10.00",
"depth": "10.00",
"optionsEnabled": false,
"origin": null,
"originId": null,
"originVariantId": null,
"rate": 0,
"migrated": false,
"price": {
"amount": "430.00",
"currencyCode": "NOK"
},
"variants": [],
"revenue": 344
}
},
{
"createdAt": "2022-10-02T21:46:21.045Z",
"updatedAt": "2022-10-02T21:46:21.045Z",
"id": 29,
"deletedAt": null,
"variantId": null,
"product": {
"createdAt": "2022-09-21T13:50:14.240Z",
"updatedAt": "2022-09-26T15:48:33.000Z",
"id": 4395,
"deletedAt": null,
"title": "Lacoste Jacket Blue",
"status": 1,
"description": "<p>Lacoste Jacket Blu</p>",
"publicPrice": "100.00",
"referralFee": 11,
"tags": "",
"sku": "BGLFPO1GJS6GT4OZ",
"barcode": "dasdasdas",
"quantity": 11,
"allowPurchaseOutOfStock": false,
"weight": "2.50",
"shipTo": null,
"width": "10.00",
"height": "10.00",
"depth": "10.00",
"optionsEnabled": false,
"origin": null,
"originId": null,
"originVariantId": null,
"rate": 0,
"migrated": false,
"price": {
"amount": "100.00",
"currencyCode": "NOK"
},
"variants": [],
"revenue": 89
}
}
],
"user": {
"id": 239
}
}

Remove item

Remove an item or multiple items from the collection.
It is possible to delete more than one item on this endpoint.
delete
https://api.outshifter.com/api
/collection/item
Remove item to collection
Body example:
{
"collection_id":"ONVV41Xei",
"product_id": 4406
}
Response example:
{
"createdAt": "2022-09-30T12:28:36.766Z",
"updatedAt": "2022-09-30T12:31:41.000Z",
"id": "ONVV41Xei",
"deletedAt": null,
"title": "Test Collection 111",
"description": "This is just a test collection",
"slug": "TestCollection",
"image": null,
"items": [],
"user": {
"id": 239
}
}

Share collection

Collections can be shared with other users on the platform. With this endpoint, you can share your collections with the users you choose by just adding the Collection ID and Outshifter ID of the specific user.
post
https://api.outshifter.com/api
/collection/shared
Share collection from logged user
Body example:
{
"collection_id":"CPa_Uquhc",
"user_id": 568
}

Delete shared collection to user

You can also unshare the collections that you shared by using the following endpoint.
delete
https://api.outshifter.com/api
/collection/shared
Delete shared collection to user
Body example:
{
"collection_id":"CPa_Uquhc",
"user_id": 568
}
Response example:
{
"message": "The collection CPa_Uquhc was disconnected to the user 568",
"status": 200
}

Get Shared with logged user

get
https://api.outshifter.com/api
/collection/shared/me
Get shared collection with logged user

Get Shared collection to user

get
https://api.outshifter.com/api
/collection/shared/to/:id