Mircate
  1. PIM
Mircate
  • Introduction
  • Authentication
  • Errors
  • Change Logs
  • 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
  • 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 Wallet
    • Create Account
    • Get Account
    • Get Accounts
    • List Accounts
    • List Transactions
    • Add Account
    • Remove Account
    • Fix
    • Load
    • Spend
    • Refund
    • Cancel
  • Talking Product
    • Create Product
    • Update Product
    • Delete Product
    • Get Product
    • List Product
  • 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
  • Common
    • Dataset
      • Create
      • Update
      • Delete
      • Value Upsert
      • Value Delete
      • List Sources
      • List Values
  • How to
    • Creating a Promotion Template
    • Promotion Transaction Flow
    • Understanding PIM Product Statuses
  1. PIM

Get Product Settings

Production
https://api.b2b.retter.io/5p1hp1d2t
Production
https://api.b2b.retter.io/5p1hp1d2t
GET
https://api.b2b.retter.io/5p1hp1d2t
/CALL/PIMAPI/getProductSettings/{PROJECT_ID}
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

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

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