EBAYCCLONE

FRONTEND GUIDE FOR AI CODING AGENTS - PART 13 - OrderManagement Service

This document is a part of a REST API guide for the ebaycclone project. It is designed for AI agents that will generate frontend code to consume the project’s backend.

This document provides extensive instruction for the usage of orderManagement

Service Access

OrderManagement service management is handled through service specific base urls.

OrderManagement service may be deployed to the preview server, staging server, or production server. Therefore,it has 3 access URLs. The frontend application must support all deployment environments during development, and the user should be able to select the target API server on the login page (already handled in first part.).

For the orderManagement service, the base URLs are:

• Preview: https://ebaycclone.prw.mindbricks.com/ordermanagement-api
• Staging: https://ebaycclone-stage.mindbricks.co/ordermanagement-api
• Production: https://ebaycclone.mindbricks.co/ordermanagement-api

Scope

OrderManagement Service Description

Handles all marketplace orders, manual checkout flows for fixed-price/offer/auction settlements, Stripe payment processing and webhook reconciliation, explicit status updates (shipping, delivery, cancellation), and feedback eligibility via orderItems.

OrderManagement service provides apis and business logic for following data objects in ebaycclone application. Each data object may be either a central domain of the application data structure or a related helper data object for a central concept. Note that data object concept is equal to table concept in the database, in the service database each data object is represented as a db table scheme and the object instances as table rows.

orderManagementOrder Data Object: Marketplace order record. Stores buyer, shipping, status, items, Stripe payment data, and manual shipment/delivery events. Only accessible to admins or the buyer/seller of order items.

orderManagementOrderItem Data Object: Order line item representing purchase of a single product from a specific seller as part of an order. Enables feedback, delivery, and per-seller analytics. Immutable after order creation.

sys_orderManagementOrderPayment Data Object: A payment storage object to store the payment life cyle of orders based on orderManagementOrder object. It is autocreated based on the source object's checkout config

sys_paymentCustomer Data Object: A payment storage object to store the customer values of the payment platform

sys_paymentMethod Data Object: A payment storage object to store the payment methods of the platform customers

OrderManagement Service Frontend Description By The Backend Architect

Order Management Service UX Guidance

• Orders are created via fixed-price (cart, buy-now), accepted offer, or auction settlement; only fixed-price products eligible for cart checkout.
• Every order contains a buyer, at least one orderItem, full shipping summary, Stripe payment references, and status.
• Seller and buyer can see different order views (purchases vs sales).
• Only seller can mark an order as shipped (manual input required).
• Only buyer can confirm delivery/completion.
• Feedback UI should only be surfaced for delivered orders, and only permit one feedback per orderItem per buyer.
• Cancellation can only occur if the order is not shipped.
• Refunds, when issued, are visible as a status; no automatic refunds.
• All price, fee, shipping, and status changes are promptly reflected in the order status/history view.
• Stripe paymentIntent update/callback events come via a single webhook endpoint.
• Sensitive payment and card info is never shown to UI/backend outside of Stripe status and method reference.

API Structure

Object Structure of a Successful Response

When the service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope includes the data and essential metadata such as configuration details and pagination information, providing context to the client.

HTTP Status Codes:

• 200 OK: Returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request was processed successfully.
• 201 Created: Returned for CREATE operations, indicating that the resource was created successfully.

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling that the request executed successfully. The structure of a successful response is outlined below:

{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3,
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}

• products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation.

Additional Data

Each API may include additional data besides the main data object, depending on the business logic of the API. These will be provided in each API’s response signature.

Error Response

If a request encounters an issue—whether due to a logical fault or a technical problem—the service responds with a standardized JSON error structure. The HTTP status code indicates the nature of the error, using commonly recognized codes for clarity:

• 400 Bad Request: The request was improperly formatted or contained invalid parameters.
• 401 Unauthorized: The request lacked a valid authentication token; login is required.
• 403 Forbidden: The current token does not grant access to the requested resource.
• 404 Not Found: The requested resource was not found on the server.
• 500 Internal Server Error: The server encountered an unexpected condition.

Each error response is structured to provide meaningful insight into the problem, assisting in efficient diagnosis and resolution.

{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}

Bucket Management

(This information is also given in PART 1 prompt.)

This application has a bucket service used to store user files and other object-related files. The bucket service is login-agnostic, so for write operations or private reads, include a bucket token (provided by services) in the request’s Authorization header as a Bearer token.

Please note that all other business services require the access token in the Bearer header, while the bucket service expects a bucket token because it is login-agnostic. Ensure you manage the required token injection properly; any auth interceptor should not replace the bucket token with the access token.

User Bucket This bucket stores public user files for each user.

When a user logs in—or in the /currentuser response—there is a userBucketToken to use when sending user-related public files to the bucket service.

{
  //...
  "userBucketToken": "e56d...."
}

To upload a file

POST {baseUrl}/bucket/upload

The request body is form-data which includes the bucketId and the file binary in the files field.

{
    bucketId: "{userId}-public-user-bucket",
    files: {binary}
}

Response status is 200 on success, e.g., body:

{
    "success": true,
    "data": [
        {
            "fileId": "9da03f6d-0409-41ad-bb06-225a244ae408",
            "originalName": "test (10).png",
            "mimeType": "image/png",
            "size": 604063,
            "status": "uploaded",
            "bucketName": "f7103b85-fcda-4dec-92c6-c336f71fd3a2-public-user-bucket",
            "isPublic": true,
            "downloadUrl": "https://babilcom.mindbricks.co/bucket/download/9da03f6d-0409-41ad-bb06-225a244ae408"
        }
    ]
}

To download a file from the bucket, you need its fileId. If you upload an avatar or other asset, ensure the download URL or the fileId is stored in the backend.

Buckets are mostly used in object creations that require an additional file, such as a product image or user avatar. After uploading your image to the bucket, insert the returned download URL into the related property of the target object record.

Application Bucket

This Ebaycclone application also includes a common public bucket that anyone can read, but only users with the superAdmin, admin, or saasAdmin roles can write (upload) to it.

When a user with one of these admin roles is logged in, the /login response or the /currentuser response also returns an applicationBucketToken field, which is used when uploading any file to the application bucket.

{
  //...
  "applicationBucketToken": "e23fd...."
}

The common public application bucket ID is

"ebaycclone-public-common-bucket"

In certain admin areas—such as product management pages—since the user already has the application bucket token, they will be able to upload related object images.

Please configure your UI to upload files to the application bucket using this bucket token whenever needed.

Object Buckets Some objects may also return a bucket token for uploading or accessing files related to that object. For example, in a project management application, when you fetch a project’s data, a public or private bucket token may be provided to upload or download project-related files.

These buckets will be used as described in the relevant object definitions.

OrderManagementOrder Data Object

Marketplace order record. Stores buyer, shipping, status, items, Stripe payment data, and manual shipment/delivery events. Only accessible to admins or the buyer/seller of order items.

OrderManagementOrder Data Object Frontend Description By The Backend Architect

• Orders represent a single completed (or pending) marketplace transaction, either from buy-now, cart, offer, or auction.
• Each order is associated with a unique orderNumber, buyer (userId), Stripe payment reference, shipping summary, and array of items (via orderItems).
• Status workflow: PENDING_PAYMENT → PAID → (manual) PROCESSING/SHIPPED → DELIVERED or CANCELLED/REFUNDED.
• Only the buyer and seller(s) of items contained can view details.
• Seller(s) can mark as SHIPPED, entering tracking and carrier manually.
• Only buyer can confirm delivery as DELIVERED.
• Feedback opening is triggered on DELIVERED.

OrderManagementOrder Data Object Properties

OrderManagementOrder data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Array Properties

items

Array properties can hold multiple values. Array properties should be respected according to their multiple structure in the frontend in any user input for them. Please use multiple input components for the array proeprties when needed.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

• status: [PENDING_PAYMENT, PAID, PROCESSING, SHIPPED, DELIVERED, CANCELLED, REFUNDED]

• _paymentConfirmation: [pending, processing, paid, canceled]

Relation Properties

items buyerId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• items: ID Relation to orderManagementOrderItem.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: No

• buyerId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Filter Properties

orderNumber status _paymentConfirmation

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• orderNumber: String has a filter named orderNumber

• status: Enum has a filter named status

• _paymentConfirmation: Enum has a filter named _paymentConfirmation

OrderManagementOrderItem Data Object

Order line item representing purchase of a single product from a specific seller as part of an order. Enables feedback, delivery, and per-seller analytics. Immutable after order creation.

OrderManagementOrderItem Data Object Frontend Description By The Backend Architect

• Each orderManagementOrderItem represents a single product in an order, including productId, quantity, price, and its seller.
• Feedback is referenced per (buyer, orderItemId), and status of delivery feedback is modeled via delivery date on parent order.
• This object is never directly modifiable after creation, except for soft-deletion by admin or integrity actions.

OrderManagementOrderItem Data Object Properties

OrderManagementOrderItem data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Relation Properties

orderId productId sellerId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• orderId: ID Relation to orderManagementOrder.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

• productId: ID Relation to productListingProduct.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

• sellerId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Sys_orderManagementOrderPayment Data Object

A payment storage object to store the payment life cyle of orders based on orderManagementOrder object. It is autocreated based on the source object's checkout config

Sys_orderManagementOrderPayment Data Object Properties

Sys_orderManagementOrderPayment data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Filter Properties

ownerId orderId paymentId paymentStatus statusLiteral redirectUrl

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• ownerId: ID has a filter named ownerId

• orderId: ID has a filter named orderId

• paymentId: String has a filter named paymentId

• paymentStatus: String has a filter named paymentStatus

• statusLiteral: String has a filter named statusLiteral

• redirectUrl: String has a filter named redirectUrl

Sys_paymentCustomer Data Object

A payment storage object to store the customer values of the payment platform

Sys_paymentCustomer Data Object Properties

Sys_paymentCustomer data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Filter Properties

userId customerId platform

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• userId: ID has a filter named userId

• customerId: String has a filter named customerId

• platform: String has a filter named platform

Sys_paymentMethod Data Object

A payment storage object to store the payment methods of the platform customers

Sys_paymentMethod Data Object Properties

Sys_paymentMethod data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Filter Properties

paymentMethodId userId customerId cardHolderName cardHolderZip platform cardInfo

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• paymentMethodId: String has a filter named paymentMethodId

• userId: ID has a filter named userId

• customerId: String has a filter named customerId

• cardHolderName: String has a filter named cardHolderName

• cardHolderZip: String has a filter named cardHolderZip

• platform: String has a filter named platform

• cardInfo: Object has a filter named cardInfo

API Reference

List Ordermanagementorders API

List orders, filtered for buyer and/or seller, or by admin. Includes select orderItems.

Rest Route

The listOrderManagementOrders API REST controller can be triggered via the following route:

/v1/ordermanagementorders

Rest Request Parameters The listOrderManagementOrders api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorders

  axios({
    method: 'GET',
    url: '/v1/ordermanagementorders',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrders",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"orderManagementOrders": [
		{
			"id": "ID",
			"orderNumber": "String",
			"items": "ID",
			"buyerId": "ID",
			"status": "Enum",
			"status_idx": "Integer",
			"paymentMethodId": "String",
			"stripeCustomerId": "String",
			"paymentIntentId": "String",
			"shippingAddress": "Object",
			"summary": "Object",
			"trackingNumber": "String",
			"estimatedDelivery": "Date",
			"cancelledAt": "Date",
			"paidAt": "Date",
			"deliveredAt": "Date",
			"shippedAt": "Date",
			"carrier": "String",
			"_paymentConfirmation": "Enum",
			"_paymentConfirmation_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Get Ordermanagementorderitem API

Get a specific order item (for feedback/business logic).

Rest Route

The getOrderManagementOrderItem API REST controller can be triggered via the following route:

/v1/ordermanagementorderitems/:orderManagementOrderItemId

Rest Request Parameters

The getOrderManagementOrderItem api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorderitems/:orderManagementOrderItemId

  axios({
    method: 'GET',
    url: `/v1/ordermanagementorderitems/${orderManagementOrderItemId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrderItem",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrderItem": {
		"id": "ID",
		"shipping": "Double",
		"orderId": "ID",
		"quantity": "Integer",
		"productId": "ID",
		"price": "Double",
		"sellerId": "ID",
		"title": "String",
		"currency": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Ordermanagementorder API

Soft-delete/cancel order by admin or eligible actor prior to shipment. Sets status to CANCELLED and cancels active payment intent if pending. Irreversible and blocks feedback.

Rest Route

The deleteOrderManagementOrder API REST controller can be triggered via the following route:

/v1/ordermanagementorders/:orderManagementOrderId

Rest Request Parameters

The deleteOrderManagementOrder api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/ordermanagementorders/:orderManagementOrderId

  axios({
    method: 'DELETE',
    url: `/v1/ordermanagementorders/${orderManagementOrderId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Ordermanagementorder API

Get single order by ID. Only accessible to admin, buyer, or relevant sellers of items within this order. Includes all orderItems.

Rest Route

The getOrderManagementOrder API REST controller can be triggered via the following route:

/v1/ordermanagementorders/:orderManagementOrderId

Rest Request Parameters

The getOrderManagementOrder api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorders/:orderManagementOrderId

  axios({
    method: 'GET',
    url: `/v1/ordermanagementorders/${orderManagementOrderId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Ordermanagementorderstatus API

Update order status (manual shipment, delivery, cancellation/refund). Restricted: only seller of all items can mark as shipped, only buyer can confirm delivery, only admin can set refund/cancelled. Timestamps updated as per business rule.

Rest Route

The updateOrderManagementOrderStatus API REST controller can be triggered via the following route:

/v1/ordermanagementorderstatus/:orderManagementOrderId

Rest Request Parameters

The updateOrderManagementOrderStatus api has got 10 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/ordermanagementorderstatus/:orderManagementOrderId

  axios({
    method: 'PATCH',
    url: `/v1/ordermanagementorderstatus/${orderManagementOrderId}`,
    data: {
            status:"Enum",  
            paymentIntentId:"String",  
            trackingNumber:"String",  
            estimatedDelivery:"Date",  
            cancelledAt:"Date",  
            paidAt:"Date",  
            deliveredAt:"Date",  
            shippedAt:"Date",  
            carrier:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Complete Orderstripewebhook API

Webhook endpoint called by Stripe to reconcile payment state and update order status based on paymentIntentId and event data. No authentication required (Stripe IPs only).

Rest Route

The completeOrderStripeWebhook API REST controller can be triggered via the following route:

/v1/completeorderstripewebhook/:orderManagementOrderId

Rest Request Parameters

The completeOrderStripeWebhook api has got 10 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/completeorderstripewebhook/:orderManagementOrderId

  axios({
    method: 'PATCH',
    url: `/v1/completeorderstripewebhook/${orderManagementOrderId}`,
    data: {
            status:"Enum",  
            paymentIntentId:"String",  
            trackingNumber:"String",  
            estimatedDelivery:"Date",  
            cancelledAt:"Date",  
            paidAt:"Date",  
            deliveredAt:"Date",  
            shippedAt:"Date",  
            carrier:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Ordermanagementorderbyproductid API

get orders by productId

Rest Route

The getOrderManagementOrderByProductId API REST controller can be triggered via the following route:

/v1/ordermanagementorderbyproductid/:items

Rest Request Parameters

The getOrderManagementOrderByProductId api has got 2 request parameters

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorderbyproductid/:items

  axios({
    method: 'GET',
    url: `/v1/ordermanagementorderbyproductid/${items}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Ordermanagementorder API

Creates an order and initiates Stripe payment. Validates that all products in the order are fixed-price, populates orderItems, saves Stripe customer/paymentMethod/paymentIntentId for reconciliation. Only accessible to buyers for own checkouts and only allows fixed-price product checkout (no auction).

Rest Route

The createOrderManagementOrder API REST controller can be triggered via the following route:

/v1/ordermanagementorders

Rest Request Parameters

The createOrderManagementOrder api has got 14 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/ordermanagementorders

  axios({
    method: 'POST',
    url: '/v1/ordermanagementorders',
    data: {
            orderNumber:"String",  
            items:"ID",  
            paymentMethodId:"String",  
            stripeCustomerId:"String",  
            paymentIntentId:"String",  
            shippingAddress:"Object",  
            summary:"Object",  
            trackingNumber:"String",  
            estimatedDelivery:"Date",  
            cancelledAt:"Date",  
            paidAt:"Date",  
            deliveredAt:"Date",  
            shippedAt:"Date",  
            carrier:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Ordermanagementorderitems API

List order items for a given order or for buyer/seller analytics. Used for feedback management.

Rest Route

The listOrderManagementOrderItems API REST controller can be triggered via the following route:

/v1/ordermanagementorderitems

Rest Request Parameters The listOrderManagementOrderItems api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorderitems

  axios({
    method: 'GET',
    url: '/v1/ordermanagementorderitems',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrderItems",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"orderManagementOrderItems": [
		{
			"id": "ID",
			"shipping": "Double",
			"orderId": "ID",
			"quantity": "Integer",
			"productId": "ID",
			"price": "Double",
			"sellerId": "ID",
			"title": "String",
			"currency": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Ownordermanagementorders API

list the loggedin user orders

Rest Route

The listOwnOrderManagementOrders API REST controller can be triggered via the following route:

/v1/ownordermanagementorders

Rest Request Parameters The listOwnOrderManagementOrders api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/ownordermanagementorders

  axios({
    method: 'GET',
    url: '/v1/ownordermanagementorders',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrders",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"orderManagementOrders": [
		{
			"id": "ID",
			"orderNumber": "String",
			"items": "ID",
			"buyerId": "ID",
			"status": "Enum",
			"status_idx": "Integer",
			"paymentMethodId": "String",
			"stripeCustomerId": "String",
			"paymentIntentId": "String",
			"shippingAddress": "Object",
			"summary": "Object",
			"trackingNumber": "String",
			"estimatedDelivery": "Date",
			"cancelledAt": "Date",
			"paidAt": "Date",
			"deliveredAt": "Date",
			"shippedAt": "Date",
			"carrier": "String",
			"_paymentConfirmation": "Enum",
			"_paymentConfirmation_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Lis Ordermanagementownorderitem API

list the loggedin user's order items

Rest Route

The lisOrderManagementOwnOrderItem API REST controller can be triggered via the following route:

/v1/lisordermanagementownorderitem

Rest Request Parameters The lisOrderManagementOwnOrderItem api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/lisordermanagementownorderitem

  axios({
    method: 'GET',
    url: '/v1/lisordermanagementownorderitem',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrderItems",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"orderManagementOrderItems": [
		{
			"id": "ID",
			"shipping": "Double",
			"orderId": "ID",
			"quantity": "Integer",
			"productId": "ID",
			"price": "Double",
			"sellerId": "ID",
			"title": "String",
			"currency": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Ordermanagementorderitem API

create order item

Rest Route

The createOrderManagementOrderItem API REST controller can be triggered via the following route:

/v1/ordermanagementorderitems

Rest Request Parameters

The createOrderManagementOrderItem api has got 8 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/ordermanagementorderitems

  axios({
    method: 'POST',
    url: '/v1/ordermanagementorderitems',
    data: {
            shipping:"Double",  
            orderId:"ID",  
            quantity:"Integer",  
            productId:"ID",  
            price:"Double",  
            sellerId:"ID",  
            title:"String",  
            currency:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrderItem",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrderItem": {
		"id": "ID",
		"shipping": "Double",
		"orderId": "ID",
		"quantity": "Integer",
		"productId": "ID",
		"price": "Double",
		"sellerId": "ID",
		"title": "String",
		"currency": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Ordermanagementorderpayment2 API

This route is used to get the payment information by ID.

Rest Route

The getOrderManagementOrderPayment2 API REST controller can be triggered via the following route:

/v1/ordermanagementorderpayment2/:sys_orderManagementOrderPaymentId

Rest Request Parameters

The getOrderManagementOrderPayment2 api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorderpayment2/:sys_orderManagementOrderPaymentId

  axios({
    method: 'GET',
    url: `/v1/ordermanagementorderpayment2/${sys_orderManagementOrderPaymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_orderManagementOrderPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Ordermanagementorderpayments2 API

This route is used to list all payments.

Rest Route

The listOrderManagementOrderPayments2 API REST controller can be triggered via the following route:

/v1/ordermanagementorderpayments2

Rest Request Parameters The listOrderManagementOrderPayments2 api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorderpayments2

  axios({
    method: 'GET',
    url: '/v1/ordermanagementorderpayments2',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayments",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_orderManagementOrderPayments": [
		{
			"id": "ID",
			"ownerId": "ID",
			"orderId": "ID",
			"paymentId": "String",
			"paymentStatus": "String",
			"statusLiteral": "String",
			"redirectUrl": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Ordermanagementorderpayment API

This route is used to create a new payment.

Rest Route

The createOrderManagementOrderPayment API REST controller can be triggered via the following route:

/v1/ordermanagementorderpayment

Rest Request Parameters

The createOrderManagementOrderPayment api has got 5 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/ordermanagementorderpayment

  axios({
    method: 'POST',
    url: '/v1/ordermanagementorderpayment',
    data: {
            orderId:"ID",  
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayment",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_orderManagementOrderPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Ordermanagementorderpayment API

This route is used to update an existing payment.

Rest Route

The updateOrderManagementOrderPayment API REST controller can be triggered via the following route:

/v1/ordermanagementorderpayment/:sys_orderManagementOrderPaymentId

Rest Request Parameters

The updateOrderManagementOrderPayment api has got 5 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/ordermanagementorderpayment/:sys_orderManagementOrderPaymentId

  axios({
    method: 'PATCH',
    url: `/v1/ordermanagementorderpayment/${sys_orderManagementOrderPaymentId}`,
    data: {
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayment",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_orderManagementOrderPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Ordermanagementorderpayment API

This route is used to delete a payment.

Rest Route

The deleteOrderManagementOrderPayment API REST controller can be triggered via the following route:

/v1/ordermanagementorderpayment/:sys_orderManagementOrderPaymentId

Rest Request Parameters

The deleteOrderManagementOrderPayment api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/ordermanagementorderpayment/:sys_orderManagementOrderPaymentId

  axios({
    method: 'DELETE',
    url: `/v1/ordermanagementorderpayment/${sys_orderManagementOrderPaymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayment",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_orderManagementOrderPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Ordermanagementorderpayments2 API

This route is used to list all payments.

Rest Route

The listOrderManagementOrderPayments2 API REST controller can be triggered via the following route:

/v1/ordermanagementorderpayments2

Rest Request Parameters The listOrderManagementOrderPayments2 api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorderpayments2

  axios({
    method: 'GET',
    url: '/v1/ordermanagementorderpayments2',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayments",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_orderManagementOrderPayments": [
		{
			"id": "ID",
			"ownerId": "ID",
			"orderId": "ID",
			"paymentId": "String",
			"paymentStatus": "String",
			"statusLiteral": "String",
			"redirectUrl": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Get Ordermanagementorderpaymentbyorderid API

This route is used to get the payment information by order id.

Rest Route

The getOrderManagementOrderPaymentByOrderId API REST controller can be triggered via the following route:

/v1/orderManagementOrderpaymentbyorderid/:orderId

Rest Request Parameters

The getOrderManagementOrderPaymentByOrderId api has got 2 request parameters

REST Request To access the api you can use the REST controller with the path GET /v1/orderManagementOrderpaymentbyorderid/:orderId

  axios({
    method: 'GET',
    url: `/v1/orderManagementOrderpaymentbyorderid/${orderId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_orderManagementOrderPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Ordermanagementorderpaymentbypaymentid API

This route is used to get the payment information by payment id.

Rest Route

The getOrderManagementOrderPaymentByPaymentId API REST controller can be triggered via the following route:

/v1/orderManagementOrderpaymentbypaymentid/:paymentId

Rest Request Parameters

The getOrderManagementOrderPaymentByPaymentId api has got 2 request parameters

REST Request To access the api you can use the REST controller with the path GET /v1/orderManagementOrderpaymentbypaymentid/:paymentId

  axios({
    method: 'GET',
    url: `/v1/orderManagementOrderpaymentbypaymentid/${paymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_orderManagementOrderPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Ordermanagementorderpayment2 API

This route is used to get the payment information by ID.

Rest Route

The getOrderManagementOrderPayment2 API REST controller can be triggered via the following route:

/v1/ordermanagementorderpayment2/:sys_orderManagementOrderPaymentId

Rest Request Parameters

The getOrderManagementOrderPayment2 api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/ordermanagementorderpayment2/:sys_orderManagementOrderPaymentId

  axios({
    method: 'GET',
    url: `/v1/ordermanagementorderpayment2/${sys_orderManagementOrderPaymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_orderManagementOrderPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_orderManagementOrderPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Start Ordermanagementorderpayment API

Start payment for orderManagementOrder

Rest Route

The startOrderManagementOrderPayment API REST controller can be triggered via the following route:

/v1/startordermanagementorderpayment/:orderManagementOrderId

Rest Request Parameters

The startOrderManagementOrderPayment api has got 2 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/startordermanagementorderpayment/:orderManagementOrderId

  axios({
    method: 'PATCH',
    url: `/v1/startordermanagementorderpayment/${orderManagementOrderId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}

Refresh Ordermanagementorderpayment API

Refresh payment info for orderManagementOrder from Stripe

Rest Route

The refreshOrderManagementOrderPayment API REST controller can be triggered via the following route:

/v1/refreshordermanagementorderpayment/:orderManagementOrderId

Rest Request Parameters

The refreshOrderManagementOrderPayment api has got 2 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/refreshordermanagementorderpayment/:orderManagementOrderId

  axios({
    method: 'PATCH',
    url: `/v1/refreshordermanagementorderpayment/${orderManagementOrderId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}

Callback Ordermanagementorderpayment API

Refresh payment values by gateway webhook call for orderManagementOrder

Rest Route

The callbackOrderManagementOrderPayment API REST controller can be triggered via the following route:

/v1/callbackordermanagementorderpayment

Rest Request Parameters

The callbackOrderManagementOrderPayment api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path POST /v1/callbackordermanagementorderpayment

  axios({
    method: 'POST',
    url: '/v1/callbackordermanagementorderpayment',
    data: {
            orderManagementOrderId:"ID",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "orderManagementOrder",
	"method": "POST",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"orderManagementOrder": {
		"id": "ID",
		"orderNumber": "String",
		"items": "ID",
		"buyerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"paymentMethodId": "String",
		"stripeCustomerId": "String",
		"paymentIntentId": "String",
		"shippingAddress": "Object",
		"summary": "Object",
		"trackingNumber": "String",
		"estimatedDelivery": "Date",
		"cancelledAt": "Date",
		"paidAt": "Date",
		"deliveredAt": "Date",
		"shippedAt": "Date",
		"carrier": "String",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}