Admin api orders

Add vendor metadata to order

POST
/api/admin/v2/orders/{orderId}/vendor-metadata/{vendorName}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

orderId*integer

Order ID

vendorName*string

Vendor name to associate the metadata with

Request Body

application/json

type*string

Type of metadata entry (e.g., DISCOUNT, SURCHARGE, EMV, EXTRA_TEXT, or custom type)

value*string

Value of the metadata entry

Response Body

application/json

application/json

curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/orders/0/vendor-metadata/string" \  -H "Content-Type: application/json" \  -d '{    "type": "DISCOUNT",    "value": "Applied discount 5% total due to using Platinum Credit Card."  }'
{
  "orderId": 0,
  "orderVersion": 0,
  "vendorName": "string",
  "metadata": {}
}
Empty
Empty
{
  "message": "Invalid request body",
  "type": "E_INVALID_BODY",
  "errors": [
    {
      "error": "\"email\" is required",
      "rule": "any.required",
      "field": "\"email\""
    }
  ]
}

How is this guide?

AiFI AI Chat

Beta

Powered by AiFi

Ask docs or API questions to get grounded answers.