Handling Orders
Creating Orders
Create Order
POST
https://api.cryptum.io/plugins/orders/checkout
This endpoint is used to create new orders
Request Body
Name | Type | Description |
---|---|---|
ecommerceOrderId* | string | The id of the order according to your application. This number is arbitrary and may follow your own business logic. |
ecommerceType* | enum | For the checkout API, this parameter should be "api". Our wordpress plugin uses "wordpress". |
orderTotal* | string | Numerical value of the order |
orderCurrency* | string | Which currency the order is based on. |
paymentStatus | enum | Either "pending" or "on-hold" |
callbackUrl* | string | The address that will receive notifications regarding the order. |
store* | string | The store ID that can be found in our dashboard, under your project. |
deliveryInfo* | object | Specified bellow. |
deliveryInfo.firstName* | string | First name of the customer. |
deliveryInfo.lastName* | string | Last name of the customer |
deliveryInfo.email* | string | Email of the customer |
deliveryInfo.country* | string | Country of the customer |
Updating Orders
Update Orders
PUT
https://api.cryptum.io/plugins/checkout/{orderId}
This endpoint is used to update existing orders.
Path Parameters
Name | Type | Description |
---|---|---|
orderId* | string | The id of the order that will be updated. |
Request Body
Name | Type | Description |
---|---|---|
transactionHash | string | Hash of the transaction that represented the order in the blockchain. |
paymentMethod | string | Payment method used for the transaction. e.g. "CELO" |
paymentStatus | enum | "pending", "on-hold", "failed" or "cancelled". |
blockchain | string | Which blockchain is being used. |
convertedTotal | string | Converted order total. |
Get Order
Get Order
GET
https://api.cryptum.io/plugins/orders/{orderId}
Use this endpoint to fetch information of an individual order.
Path Parameters
Name | Type | Description |
---|---|---|
orderId* | string | The id of the order that will be fetched. |
Get Orders
Get Multiple Orders
GET
https://api.cryptum.io/plugins/orders/
Query Parameters
Name | Type | Description |
---|---|---|
limit | number | Default: 100 |
offset | number | Default: 0 |
storeId* | string | |
paymentStatus | enum | "pending", "on-hold", "failed" "cancelled" or "confirmed" |
startDate | string | |
endDate | string | |
withCount | boolean | |
withTotal | boolean |
Last updated