Update an order

To update an order, you use orders resource. Orders expire after 24 hours unless the payment is captured.

patch/orders/{orderId}

Request

Base URL
https://api.sandbox.cleeng.com/3.1
URL
https://api.sandbox.cleeng.com/3.1/orders/{orderId}
Auth
API key in header X-Publisher-Token

Path parameters

orderIdstring required

The identifier of the Cleeng order.

Headers

Content-Typestring

Request body

paymentMethodIdstring

The identifier of the payment method, provided by Cleeng.

couponCodestring

Applied coupon code.

taxRatestring

Tax rate in float (eg '0.23').

buyAsAGiftboolean

Whether an order refers to gift purchase.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "order": {
    "id": 159026691,
    "customerId": 771994569,
    "customer": {
      "locale": "en_US",
      "email": "test@test.com"
    },
    "publisherId": 167631863,
    "offerId": "S398236333_PL",
    "offer": {
      "title": "Title",
      "price": 4.065,
      "currency": "EUR"
    },
    "totalPrice": 9.3217,
    "priceBreakdown": {
      "offerPrice": 4.74,
      "discountAmount": 0.95,
      "discountedPrice": 3.79,
      "taxValue": 0.87,
      "paymentMethodFee": 4.6617
    },
    "taxRate": 0.23,
    "currency": "USD",
    "country": "PL",
    "paymentMethodId": 399207736,
    "expirationDate": 1574333220,
    "billingAddress": {
      "billingStreetName": "street",
      "billingStreetNumber": "123",
      "billingPostalCode": "62-025"
    },
    "couponId": 6,
    "discount": {
      "applied": true,
      "type": "coupon",
      "periods": 10
    }
  },
  "message": "Order updated successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.