Mircate
  1. PIM
Mircate
  • Introduction
  • Authentication
  • Errors
  • Change Logs
  • Promotion
    • Calculate
      POST
    • Start Transaction
      POST
    • Commit Transaction
      POST
    • Revert Transaction
      POST
    • Cancel Transaction
      POST
    • Get Active Promotions
      GET
  • Loyalty
    • Receive Event
      POST
    • Calculate
      POST
    • Start Transaction
      POST
    • Commit Transaction
      POST
    • Cancel Transaction
      POST
    • List Measurements
      POST
  • Wallet
    • Get Wallet
    • Create Account
    • Get Account
    • Get Accounts
    • List Accounts
    • List Transactions
    • Add Account
    • Remove Account
    • Fix
    • Load
    • Spend
    • Refund
    • Cancel
  • PIM
    • Get Products
      POST
    • Get Product Settings
      GET
    • Get Catalog Settings
      GET
    • Upsert Product
      POST
    • Upsert Category
      POST
    • Bulk Product Upsert
      POST
    • Check Batch Status
      POST
    • Delete Product
      POST
    • Attach Product Attribute Image
      POST
    • Attach Category Image
      POST
    • Get Image
      GET
    • Upsert Attributes
      POST
    • Delete Attribute
      POST
    • Upsert Attribute Options
      POST
    • Upsert Attribute Option
      POST
    • Delete Attribute Option
      POST
  • Merchant
    • Sales Channel
      • Reserve Stock
      • Cancel Stock
      • Commit Stock
      • Refund Stock
      • Get Current Stock
    • Product Supplier
      • Receive Stock
      • Receive Price
      • Get Stock/Price History
      • Check Batch Status
      • Remove My Products
      • Clean My Products
      • Export Stock/Price
      • List Exports
      • Get Exported Files
    • Global Products
      • Receive Products
      • Get Global Products
      • Remove Global Products
  • How to
    • Creating a Promotion Template
    • Promotion Transaction Flow
    • Understanding PIM Product Statuses
  1. PIM

Get Product Settings

Production
Production
GET
https://api.b2b.retter.io/5p1hp1d2t/CALL/PIMAPI/getProductSettings/{PROJECT_ID}
PIM
Last modified:2024-09-17 11:22:35
You can access this API using an API key.
This method allows you to retrieve the information of products based on the provided parameters. It returns attributes, attribute options, families, attribute groups, group types, and groups associated with the products.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
PROJECT_ID
string 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.b2b.retter.io/5p1hp1d2t/CALL/PIMAPI/getProductSettings/' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
Successful response
Body
productSettings
object 
optional
attributes
array [object {12}] 
optional
A product attribute in a PIM refers to a characteristic or property that describes a product.
attributeOptions
array [object {2}] 
optional
families
array [object {6}] 
optional
A family in the context of a PIM is a group of attributes that are associated with similar types of products. It allows for the organization and management of attributes specific to certain product categories.
attributeGroups
array [object {2}] 
optional
groupTypes
array [object] 
optional
Product Groups also have types.Type can be used to differentiate the product groups.
groups
array [object] 
optional
Product Groups are used to label a group of which do not have any relation.
Example
{
  "productSettings": {
    "attributes": [
      {
        "availableLocales": [
          "string"
        ],
        "isLocaleSpecific": true,
        "localizable": true,
        "scopable": true,
        "code": "string",
        "type": "string",
        "group": "string",
        "isUnique": true,
        "label": [
          {
            "locale": "string",
            "value": "string"
          }
        ],
        "maxCharacters": 0,
        "validationRegexp": "string",
        "validationRule": "string"
      }
    ],
    "attributeOptions": [
      {
        "code": "string",
        "options": [
          {
            "code": "string",
            "label": [
              {
                "locale": "string",
                "value": "string"
              }
            ]
          }
        ]
      }
    ],
    "families": [
      {
        "code": "string",
        "label": [
          {
            "locale": "string",
            "value": "string"
          }
        ],
        "attributeAsLabel": "string",
        "attributes": [
          {
            "attribute": "string",
            "requiredChannels": [
              {}
            ]
          }
        ],
        "variants": [
          {
            "code": "string",
            "label": [
              {}
            ],
            "axes": [
              "string"
            ],
            "attributes": [
              "string"
            ]
          }
        ],
        "attributeAsImage": "string"
      }
    ],
    "attributeGroups": [
      {
        "code": "string",
        "label": [
          {
            "locale": "string",
            "value": "string"
          }
        ]
      }
    ],
    "groupTypes": [
      {}
    ],
    "groups": [
      {}
    ]
  }
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-09-17 11:22:35
Previous
Get Products
Next
Get Catalog Settings
Built with