Store

Setiap aksi di bawah berjalan di workspace pemilik API key, setelah @beamvia-plugin/store terpasang di sana. Kirim input sebagai body JSON; Idempotency-Key membuat percobaan ulang mengembalikan hasil pertama.

productList

Products with their variants and stock.

Scopeplugin:read

POSThttps://www.beamvia.com/api/v1/plugin/store/productList

productList

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/productList" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

productGet

One product with its variants.

Scopeplugin:read

idstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/productGet

productGet

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/productGet" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

productUpsert

Scopeplugin:write

productobjectrequired

variantsarrayrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/productUpsert

productUpsert

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/productUpsert" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product": {},
    "variants": [
      {}
    ]
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

productArchive

Archive a product.

Scopeplugin:write

productIdstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/productArchive

productArchive

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/productArchive" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

Scopeplugin:read

POSThttps://www.beamvia.com/api/v1/plugin/store/categoryList

categoryList

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/categoryList" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

categoryUpsert

Scopeplugin:write

idstring | nullrequired

namestringrequired

parentIdstring | nullrequired

descriptionstring

imageobject | null

seoobject

POSThttps://www.beamvia.com/api/v1/plugin/store/categoryUpsert

categoryUpsert

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/categoryUpsert" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "",
    "name": "",
    "parentId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

inventoryOverview

Scopeplugin:read

POSThttps://www.beamvia.com/api/v1/plugin/store/inventoryOverview

inventoryOverview

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/inventoryOverview" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

inventoryImport

Scopeplugin:write

variantIdstringrequired

valuesarrayrequired

fileobject | null

batchstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/inventoryImport

inventoryImport

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/inventoryImport" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "variantId": "",
    "values": [
      ""
    ],
    "batch": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

inventoryAdjust

Scopeplugin:write

variantIdstringrequired

deltaintegerrequired

reasonstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/inventoryAdjust

inventoryAdjust

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/inventoryAdjust" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "variantId": "",
    "delta": 1,
    "reason": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderCreate

Create an order (or a draft). Lines name a variant by variantId or sku.

Scopeplugin:write

linesarrayrequired

customerobjectrequired

contactIdstring | nullrequired

conversationIdstring | nullrequired

methodIdstring | nullrequired

isDraftbooleanrequired

notestringrequired

shippingobject | null

codesarray

scheduleobject | null

POSThttps://www.beamvia.com/api/v1/plugin/store/orderCreate

orderCreate

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderCreate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lines": [
      {
        "quantity": 1,
        "addons": [
          ""
        ],
        "answers": {}
      }
    ],
    "customer": {
      "name": "",
      "email": "",
      "phone": ""
    },
    "contactId": "",
    "conversationId": "",
    "methodId": "",
    "isDraft": false,
    "note": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderComplete

Scopeplugin:write

orderIdstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/orderComplete

orderComplete

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderComplete" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderList

Orders newest first, 50 a page. Filter by view, search, created.from/to, contactId or source.channel.

Scopeplugin:read

viewenumrequired

ALL, UNPAID, REVIEW, FULFIL, SHIPPED, COMPLETED, CANCELLED, DRAFT

searchstringrequired

cursorstring | nullrequired

createdobject

contactIdstring | null

sourceobject

POSThttps://www.beamvia.com/api/v1/plugin/store/orderList

orderList

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderList" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "view": "ALL",
    "search": "",
    "cursor": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderGet

One order with its payments, shipments and timeline.

Scopeplugin:read

orderIdstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/orderGet

orderGet

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderGet" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderUpdate

Change an order's customer, address, note or tags. Pass version (its updatedAt) to refuse a stale edit.

Scopeplugin:write

orderIdstringrequired

linesarray | nullrequired

customerobject | nullrequired

versionstring | null

POSThttps://www.beamvia.com/api/v1/plugin/store/orderUpdate

orderUpdate

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderUpdate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": "",
    "lines": [
      {}
    ],
    "customer": {}
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderCancel

Cancel an order: stock and codes go back.

Scopeplugin:write

orderIdstringrequired

reasonstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/orderCancel

orderCancel

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderCancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": "",
    "reason": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

paymentList

Scopeplugin:read

orderIdstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/paymentList

paymentList

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/paymentList" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

paymentRecord

Scopeplugin:write

orderIdstringrequired

amountintegerrequired

methodIdstring | nullrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/paymentRecord

paymentRecord

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/paymentRecord" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": "",
    "amount": 1,
    "methodId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderRefund

Scopeplugin:write

orderIdstringrequired

amountinteger | nullrequired

null = everything paid (or the lines' share when lines are given)

linesarray | null

isShippingboolean

reasonstringrequired

isRestockbooleanrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/orderRefund

orderRefund

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderRefund" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": "",
    "amount": 1,
    "reason": "",
    "isRestock": false
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

customerList

Scopeplugin:read

POSThttps://www.beamvia.com/api/v1/plugin/store/customerList

customerList

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/customerList" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

customerOrders

Scopeplugin:read

contactIdstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/customerOrders

customerOrders

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/customerOrders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contactId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

discountList

Scopeplugin:read

POSThttps://www.beamvia.com/api/v1/plugin/store/discountList

discountList

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/discountList" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

discountUpsert

Scopeplugin:write

discountobjectrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/discountUpsert

discountUpsert

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/discountUpsert" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "discount": {}
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

discountArchive

Scopeplugin:write

idstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/discountArchive

discountArchive

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/discountArchive" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

shippingQuotePreview

Scopeplugin:read

linesarrayrequired

addressobjectrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/shippingQuotePreview

shippingQuotePreview

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/shippingQuotePreview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lines": [
      {}
    ],
    "address": {}
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

shipmentList

Scopeplugin:read

orderIdstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/shipmentList

shipmentList

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/shipmentList" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

shipmentBook

Scopeplugin:write

orderIdstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/shipmentBook

shipmentBook

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/shipmentBook" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderShip

Scopeplugin:write

orderIdstringrequired

carrierstringrequired

numberstringrequired

urlstring | nullrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/orderShip

orderShip

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderShip" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": "",
    "carrier": "",
    "number": "",
    "url": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

shipmentMark

Scopeplugin:write

shipmentIdstringrequired

statusenumrequired

BOOKED, PICKED_UP, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED, FAILED, RETURNED, CANCELLED

POSThttps://www.beamvia.com/api/v1/plugin/store/shipmentMark

shipmentMark

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/shipmentMark" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shipmentId": "",
    "status": "BOOKED"
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

productExport

Scopeplugin:read

POSThttps://www.beamvia.com/api/v1/plugin/store/productExport

productExport

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/productExport" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

productImport

Import products from CSV rows; known SKUs update.

Scopeplugin:write

csvstringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/productImport

productImport

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/productImport" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "csv": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}

orderExport

Scopeplugin:read

fromstringrequired

tostringrequired

POSThttps://www.beamvia.com/api/v1/plugin/store/orderExport

orderExport

curl -X POST "https://www.beamvia.com/api/v1/plugin/store/orderExport" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "",
    "to": ""
  }'

{
  "status": true,
  "message": "OK",
  "data": {
    "result": {}
  }
}