POST

Bulk Create Ribbons

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates multiple ribbons.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Ribbon write in v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v3/bulk/ribbons/create
Body Params
ribbonsArray <Ribbon>RequiredminItems 1maxItems 100

Ribbons to create.

returnEntityboolean

Whether to return the full created ribbon entities in the response.

Default: false

Response Object
resultsArray <BulkRibbonResult>maxItems 100

Ribbons created by bulk action.

bulkActionMetadataBulkActionMetadata

Bulk action metadata.

Bulk create ribbons

Create 2 ribbons at once.

Request
cURL
curl -X POST \
 'https://www.wixapis.com/stores/v3/bulk/ribbons/create' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>' \
 -d '{
   "ribbons": [
     {
       "name": "New Offer!"
     },
     {
       "name": "New collection"
     }
   ],
   "returnEntity": true
 }'
Response
JSON
{
  "results": [
    {
      "itemMetadata": {
        "id": "9d80c64a-b39f-4b7c-b47a-2ba0e840b740",
        "originalIndex": 0,
        "success": true
      },
      "item": {
        "id": "9d80c64a-b39f-4b7c-b47a-2ba0e840b740",
        "revision": "1",
        "createdDate": "2024-06-26T09:15:22.092Z",
        "updatedDate": "2024-06-26T09:15:22.092Z",
        "name": "New Offer!"
      }
    },
    {
      "itemMetadata": {
        "id": "d9f4daa3-d122-4e84-a6b4-432f3e48cfe4",
        "originalIndex": 1,
        "success": true
      },
      "item": {
        "id": "d9f4daa3-d122-4e84-a6b4-432f3e48cfe4",
        "revision": "1",
        "createdDate": "2024-06-26T09:15:22.092Z",
        "updatedDate": "2024-06-26T09:15:22.092Z",
        "name": "New collection"
      }
    }
  ],
  "bulkActionMetadata": {
    "totalSuccesses": 2,
    "totalFailures": 0,
    "undetailedFailures": 0
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?