Dropship
Merchant API Endpoints
Suppliers
curl --request GET \
--url 'https://marketplace-api.fabric.inc/v1/rule-groups/?ruleset_id={ruleset_id}' \
--header 'Authorization: Bearer <token>'{
"count": 100,
"results": [
{
"id": 574,
"name": "SKU",
"ruleset": {
"id": 36,
"name": "fabric Merchant Ruleset",
"description": "the default fabric merchant ruleset",
"created_at": "2022-06-16T18:08:08.000Z",
"updated_at": "2022-08-24T05:38:42.000Z"
},
"description": "",
"target": null,
"is_required": true,
"position": 0,
"rules": {
"id": 574,
"name": "SKU",
"description": "",
"attribute": {
"id": 2,
"code": "identifier",
"name": "SKU",
"grouping": "identifiers",
"priority": 100,
"description": "Product SKU or Identifier",
"editable_by": "any",
"type": "string",
"units": "",
"default_unit": null,
"available_units": [],
"is_bulk_editable": false
},
"target": null,
"is_required": true,
"position": 0,
"rule_group_id": 124,
"rule_validators": [],
"rule_conditions": [],
"created_at": "2022-06-16T18:08:42.000Z",
"updated_at": "2022-06-16T18:08:42.000Z"
},
"created_at": "2022-06-16T18:08:42.000Z",
"updated_at": "2022-06-16T18:08:42.000Z"
}
],
"next": "https://api.example.org/demo/{retailer_id}/?page=5",
"previous": "https://api.example.org/demo/{retailer_id}/?page=3"
}Get ruleset details
When sending proposals to a retailer partner, rulesets define the required conditions for your product attributes. Failing to meet even one of these conditions will prevent your proposal from being submitted. Use this endpoint to review the specific details of a chosen ruleset, which will guide you in preparing your data file correctly and ensuring a successful proposal submission.
curl --request GET \
--url 'https://marketplace-api.fabric.inc/v1/rule-groups/?ruleset_id={ruleset_id}' \
--header 'Authorization: Bearer <token>'{
"count": 100,
"results": [
{
"id": 574,
"name": "SKU",
"ruleset": {
"id": 36,
"name": "fabric Merchant Ruleset",
"description": "the default fabric merchant ruleset",
"created_at": "2022-06-16T18:08:08.000Z",
"updated_at": "2022-08-24T05:38:42.000Z"
},
"description": "",
"target": null,
"is_required": true,
"position": 0,
"rules": {
"id": 574,
"name": "SKU",
"description": "",
"attribute": {
"id": 2,
"code": "identifier",
"name": "SKU",
"grouping": "identifiers",
"priority": 100,
"description": "Product SKU or Identifier",
"editable_by": "any",
"type": "string",
"units": "",
"default_unit": null,
"available_units": [],
"is_bulk_editable": false
},
"target": null,
"is_required": true,
"position": 0,
"rule_group_id": 124,
"rule_validators": [],
"rule_conditions": [],
"created_at": "2022-06-16T18:08:42.000Z",
"updated_at": "2022-06-16T18:08:42.000Z"
},
"created_at": "2022-06-16T18:08:42.000Z",
"updated_at": "2022-06-16T18:08:42.000Z"
}
],
"next": "https://api.example.org/demo/{retailer_id}/?page=5",
"previous": "https://api.example.org/demo/{retailer_id}/?page=3"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique ruleset id. The ruleset’s ID can be retrieved from the response provided by the proposal department details endpoint.
Response
OK
The total number of records
100
Show child attributes
Show child attributes
The unique identifier of the rule.
574
The name of the rule.
"SKU"
Details about a specific ruleset, including its name, description, and timestamps.
Show child attributes
Show child attributes
The unique identifier of the ruleset.
36
The name of the ruleset.
"fabric Merchant Ruleset"
A brief description of the ruleset.
"the default fabric merchant ruleset"
The timestamp when the ruleset was created.
"2022-06-16T18:08:08.000Z"
The timestamp when the ruleset was last updated.
"2022-08-24T05:38:42.000Z"
A brief description of what the rule does.
""
Specifies the target of the rule, if any.
null
Indicates if this rule is mandatory.
true
The order or priority of the rule within its group.
0
Defines a specific validation or processing rule within a ruleset.
Show child attributes
Show child attributes
The unique identifier of the rule.
574
The name of the rule.
"SKU"
A brief description of what the rule does.
""
Represents a product attribute, detailing its properties, type, and editing capabilities.
Show child attributes
Show child attributes
The unique identifier of the attribute.
2
A unique code for the attribute.
"identifier"
The display name of the attribute.
"SKU"
The category or grouping the attribute belongs to.
"identifiers"
The priority order of the attribute.
100
A detailed description of the attribute.
"Product SKU or Identifier"
Specifies who can edit the attribute (e.g., 'any', 'admin').
"any"
The data type of the attribute (e.g., 'string', 'integer', 'boolean').
"string"
The unit of measurement for the attribute, if applicable.
""
The default unit of measurement, if any.
null
A list of available units for the attribute.
[]Indicates if the attribute can be edited in bulk.
false
Specifies the target of the rule, if any.
null
Indicates if this rule is mandatory.
true
The order or priority of the rule within its group.
0
The ID of the rule group this rule belongs to.
124
A list of validators associated with this rule.
[]A list of conditions that trigger or modify this rule.
[]The timestamp when the rule was created.
"2022-06-16T18:08:42.000Z"
The timestamp when the rule was last updated.
"2022-06-16T18:08:42.000Z"
The timestamp when the ruleset was created.
"2022-06-16T18:08:42.000Z"
The timestamp when the ruleset was last updated.
"2022-06-16T18:08:42.000Z"
Next page (applicable in a paginated response)
"https://api.example.org/demo/{retailer_id}/?page=5"
Previous page (applicable in a paginated response)
"https://api.example.org/demo/{retailer_id}/?page=3"
Was this page helpful?