Referensi API

Pesanan & produk

Pesanan dan produk marketplace yang tersinkron, plus pick list dan pack list.

List orders

GET/v1/orders

Orders of the current tenant.

Scope:orders:read

Query parameter

storeIdstringopsional
format: uuid
statusOrderStatusopsional
Salah satu dari:pending_paymentprocessingshippeddeliveredcompletedcancelledreturned
fromstringopsional
Inclusive start (ISO 8601). Defaults to 30 days ago.
format: date-time
tostringopsional
Exclusive end (ISO 8601). Defaults to now.
format: date-time
qstringopsional
Matches the marketplace order id.
panjang maks 64
cursorstringopsional
limitintegeropsional
min 1 · maks 200 · default: 50

Response200 · application/json

Orders, newest first

itemsarray<Order>wajib
Tampilkan 19 atribut turunan
- idstringwajib
  format: uuid
- storeIdstringwajib
  format: uuid
- marketplacestringwajib
  Salah satu dari:tiktokshopeelazadatokopedia
- externalOrderIdstringwajib
- statusstringwajib
  Salah satu dari:pending_paymentprocessingshippeddeliveredcompletedcancelledreturned
- marketplaceStatusstringwajib
- placedAtstringwajib
  format: date-time
- paidAtstringwajibnullable
  format: date-time
- completedAtstringwajibnullable
  format: date-time
- cancelledAtstringwajibnullable
  format: date-time
- currencystringwajib
- subtotalstring (decimal)wajib
  Decimal string with two fraction digits.
- shippingFeestring (decimal)wajib
  Decimal string with two fraction digits.
- discountTotalstring (decimal)wajib
  Decimal string with two fraction digits.
- totalstring (decimal)wajib
  Decimal string with two fraction digits.
- sourceChannelstringwajib
  Salah satu dari:livevideoshopaffiliateunknown
- externalLiveIdstringwajibnullable
- itemCountintegerwajib
- syncedAtstringwajib
  format: date-time
pageInfoPageInfowajib
Tampilkan 2 atribut turunan
- nextCursorstringwajibnullable
- hasMorebooleanwajib

Contoh request · curl

curl "https://api.comnethub.app/v1/orders?limit=20" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Get order

GET/v1/orders/{orderId}

Order with items, timeline, returns, and settlements.

Scope:orders:read

Path parameter

orderIdstringwajib
format: uuid

Response200 · application/json

Order detail

idstringwajib
format: uuid
storeIdstringwajib
format: uuid
marketplacestringwajib
Salah satu dari:tiktokshopeelazadatokopedia
externalOrderIdstringwajib
statusstringwajib
Salah satu dari:pending_paymentprocessingshippeddeliveredcompletedcancelledreturned
marketplaceStatusstringwajib
placedAtstringwajib
format: date-time
paidAtstringwajibnullable
format: date-time
completedAtstringwajibnullable
format: date-time
cancelledAtstringwajibnullable
format: date-time
currencystringwajib
subtotalstring (decimal)wajib
Decimal string with two fraction digits.
shippingFeestring (decimal)wajib
Decimal string with two fraction digits.
discountTotalstring (decimal)wajib
Decimal string with two fraction digits.
totalstring (decimal)wajib
Decimal string with two fraction digits.
sourceChannelstringwajib
Salah satu dari:livevideoshopaffiliateunknown
externalLiveIdstringwajibnullable
itemCountintegerwajib
syncedAtstringwajib
format: date-time
shippedAtstringwajibnullable
format: date-time
deliveredAtstringwajibnullable
format: date-time
buyerRefstringwajibnullable
itemsarray<OrderItem>wajib
Tampilkan 11 atribut turunan
- idstringwajib
  format: uuid
- externalItemIdstringwajib
- externalProductIdstringwajibnullable
- externalSkuIdstringwajibnullable
- namestringwajib
- skustringwajibnullable
- quantityintegerwajib
- unitPricestring (decimal)wajib
  Decimal string with two fraction digits.
- subtotalstring (decimal)wajib
  Decimal string with two fraction digits.
- statusstringwajibnullable
- externalLiveIdstringwajibnullable
eventsarray<OrderEvent>wajib
Tampilkan 7 atribut turunan
- idstringwajib
  format: uuid
- kindstringwajib
  Salah satu dari:createdstatus_changedsyncedreturnsettlednote
- fromStatusstringwajibnullable
- toStatusstringwajibnullable
- occurredAtstringwajib
  format: date-time
- sourcestringwajib
  Salah satu dari:webhookbackfillmanual
- payloadobject (map)opsional
returnsarray<OrderReturn>wajib
Tampilkan 9 atribut turunan
- idstringwajib
  format: uuid
- externalReturnIdstringwajib
- typestringwajib
- statusstringwajib
- reasonstringwajibnullable
- refundAmountstring (decimal)wajib
  Decimal string with two fraction digits.
- currencystringwajibnullable
- requestedAtstringwajibnullable
  format: date-time
- resolvedAtstringwajibnullable
  format: date-time
settlementsarray<OrderSettlement>wajib
Tampilkan 8 atribut turunan
- idstringwajib
  format: uuid
- externalStatementIdstringwajib
- settlementAmountstring (decimal)wajib
  Decimal string with two fraction digits.
- revenueAmountstring (decimal)wajib
  Decimal string with two fraction digits.
- feeAmountstring (decimal)wajib
  Decimal string with two fraction digits.
- adjustmentAmountstring (decimal)wajib
  Decimal string with two fraction digits.
- currencystringwajibnullable
- settledAtstringwajibnullable
  format: date-time

Contoh request · curl

curl "https://api.comnethub.app/v1/orders/$ORDER_ID" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

List products

GET/v1/products

Products synced from marketplaces.

Scope:products:read

Query parameter

storeIdstringopsional
format: uuid
qstringopsional
panjang maks 120
cursorstringopsional
limitintegeropsional
min 1 · maks 200 · default: 50

Response200 · application/json

Products

itemsarray<Product>wajib
Tampilkan 8 atribut turunan
- idstringwajib
  format: uuid
- storeIdstringwajib
  format: uuid
- externalProductIdstringwajib
- titlestringwajib
- statusstringwajib
- imagesarray<string>wajib
- variantsarray<ProductVariant>wajib
  Tampilkan 10 atribut turunan
  - inventoryItemIdstringwajibnullable
    Master stock item this variant follows.
    format: uuid
  - managedStockbooleanwajib
    Stock is pushed from the master item; edit it there.
  - managedPricebooleanwajib
    Price is pushed from the master item; edit it there.
  - idstringwajib
    format: uuid
  - externalSkuIdstringwajib
  - skustringwajibnullable
  - namestringwajibnullable
  - pricestring (decimal)wajibnullable
    Decimal string with two fraction digits.
  - currencystringwajibnullable
  - stockintegerwajibnullable
- syncedAtstringwajib
  format: date-time
pageInfoPageInfowajib
Tampilkan 2 atribut turunan
- nextCursorstringwajibnullable
- hasMorebooleanwajib

Contoh request · curl

curl "https://api.comnethub.app/v1/products?limit=20" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Bulk pick pack

POST/v1/bulk/orders/pick-pack

Picking list (units per SKU) and packing list (per order) for printing.

Scope:orders:write

Request bodyapplication/json

orderIdsarray<Id>wajib
item min 1 · item maks 200

Response200 · application/json

Orders in request order and aggregated picks

ordersarray<PackingOrder>wajib
Tampilkan 13 atribut turunan
- orderIdstringwajib
  format: uuid
- externalOrderIdstringwajib
- storeIdstringwajib
  format: uuid
- storeNamestringwajib
- marketplacestringwajib
  Salah satu dari:tiktokshopeelazadatokopedia
- statusstringwajib
  Salah satu dari:pending_paymentprocessingshippeddeliveredcompletedcancelledreturned
- placedAtstringwajib
  format: date-time
- recipientNamestringwajibnullable
  As provided by the marketplace (often masked).
- recipientAddressstringwajibnullable
- buyerNotestringwajibnullable
- trackingNumberstringwajibnullable
- shippingProviderstringwajibnullable
- itemsarray<object>wajib
  Tampilkan 3 atribut turunan
  - namestringwajib
  - skustringwajibnullable
  - quantityintegerwajib
picksarray<PickLine>wajib
Tampilkan 4 atribut turunan
- skustringwajibnullable
- namestringwajib
- quantityintegerwajib
- ordersintegerwajib
  Number of orders that contain this line.
generatedAtstringwajib
format: date-time

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/bulk/orders/pick-pack" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "orderIds": [
    "0192f0c4-8d1e-7a4b-9c3e-5f6a7b8c9d0e"
  ]
}'