Create Order

The Create Order API is used to create an order with HIPS. The id that is generated and returned for you is used to integrate the HIPS Checkout. Authentication Key Type: SalesChannelApiKey

📘

HIPS Hosted checkout]

Read more about HIPS Hosted checkout

Example:

curl --request POST \
  --url https://api.hips.com/v2/orders \
  --header 'Accept: application/json' \
  --header 'Authorization: private_BQokikJOvBiI2HlWgH4olfQ2' \
  --header 'Content-Type: application/json' \
  --data '{  
   "order_id": "123",
   "purchase_currency": "USD",
   "user_session_id": "3246568465743",
   "user_identifier": "SmartShopper17",
   "meta_data_1": "any_custom_reference",
   "ecommerce_platform": "Magento 1.9.x.x",
   "ecommerce_module": "Hips Magento Module 0.1.0",
   "cart": {
      "items": [  
         {  
            "type": "physical",
            "sku": "3123123",
            "name": "Hips cup",
            "quantity": 1,
            "unit_price": 1000,
            "discount_rate":0,
            "vat_amount": 250,
            "meta_data_1": "Special color",
            "weight_unit": "gram",
            "weight": 350
         },
         {  
            "type": "physical",
            "sku": "456778",
            "name": "Hips T-shirt",
            "quantity": 1,
            "unit_price": 1000,
            "discount_rate":0,
            "vat_amount": 250,
            "weight_unit": "kg",
            "weight": 1.25
         },
         {  
            "type": "shipping_fee",
            "sku": "1",
            "name": "UPS Express",
            "quantity": 1,
            "unit_price": 1000,
            "discount_rate":0,
            "vat_amount": 250
         }
      ]
   },
   "checkout_settings": {
      "extended_cart": true
   },
   "require_shipping": true,
   "express_shipping": true,
   "hooks": {
    "user_return_url_on_success": "https://mystore.com/thank_you",
    "user_return_url_on_fail": "https://mystore.com/sorry",
    "terms_url": "https://mystore.com/terms",
    "webhook_url": "https://api.mystore.com/confirmations"
   }
}'
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!