Mircate
  1. Promotion
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. Promotion

Start Transaction

Production
https://api.b2b.retter.io/5p1hp1d2t
Production
https://api.b2b.retter.io/5p1hp1d2t
POST
https://api.b2b.retter.io/5p1hp1d2t
/CALL/Promotion/startTransaction/{B2B_PROMOTION_PROJECT_ID}
Last modified:2024-10-17 13:27:01
Start Transaction method indicates the commencement of the promotional transaction.

Request

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

Header Params

Body Params application/json

Example
{
    "cart": {
        "subOrders": [
            {
                "id": "string",
                "subOrderId": "string",
                "price": 0
            }
        ],
        "items": [
            {
                "id": "string",
                "qty": 0,
                "totalPrice": 0
            }
        ]
    },
    "user": {
        "userId": "string"
    },
    "pointCurrency": "string",
    "usePoint": 0,
    "storeId": "string",
    "storeName": "string",
    "transactionId": "string"
}

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 POST 'https://api.b2b.retter.io/5p1hp1d2t/CALL/Promotion/startTransaction/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "cart": {
        "subOrders": [
            {
                "id": "string",
                "subOrderId": "string",
                "price": 0
            }
        ],
        "items": [
            {
                "id": "string",
                "qty": 0,
                "totalPrice": 0
            }
        ]
    },
    "user": {
        "userId": "string"
    },
    "pointCurrency": "string",
    "usePoint": 0,
    "storeId": "string",
    "storeName": "string",
    "transactionId": "string"
}'

Responses

🟢200OK
application/json
Successful response
Body

Example
{
    "runWithLoyalty": true,
    "message": "string",
    "transactionId": "string",
    "userId": "string",
    "couponId": "string",
    "transaction": {
        "transactionId": "string",
        "promotions": [
            {
                "id": "string",
                "promotionTemplateId": "string",
                "giftAmount": 0,
                "tag": "string",
                "promotionType": "string",
                "userMessage": "string"
            }
        ],
        "couponId": "string",
        "transactionTimeout": 0,
        "cart": {
            "subOrders": [
                {
                    "merchantId": "string",
                    "subOrderId": "string",
                    "id": "string",
                    "price": 0,
                    "itemType": "string",
                    "priceAfterPromotion": 0,
                    "displayPrice": 0,
                    "promotionDiscount": 0,
                    "appliedPromotions": [
                        {
                            "id": "string",
                            "promotionTemplateId": "string",
                            "giftAmount": 0
                        }
                    ]
                }
            ],
            "items": [
                {
                    "merchantId": "string",
                    "id": "string",
                    "qty": 0,
                    "attributes": {
                        "shortName": "string",
                        "longName": "string",
                        "brand": "string",
                        "categories": [
                            {
                                "id": "string",
                                "name": "string"
                            }
                        ],
                        "images": [
                            "string"
                        ],
                        "productLimit": 0,
                        "logisticTags": [
                            {}
                        ],
                        "etiketler": [
                            "string"
                        ]
                    },
                    "price": 0,
                    "totalPrice": 0,
                    "itemType": "string",
                    "promotionDiscount": 0,
                    "priceAfterPromotion": 0,
                    "appliedPromotions": [
                        {
                            "id": "string",
                            "promotionTemplateId": "string",
                            "giftAmount": 0
                        }
                    ],
                    "totalPromotionDiscount": 0,
                    "totalPriceAfterPromotion": 0,
                    "totalDisplayPrice": 0
                }
            ]
        }
    }
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-10-17 13:27:01
Previous
Calculate
Next
Commit Transaction
Built with