Referensi API

Fulfillment & katalog

Aksi langsung ke marketplace: pengiriman, label, keputusan after-sales, dan listing produk.

List catalog categories

GET/v1/stores/{storeId}/catalog/categories

Leaf categories the shop may list in, filtered by name or path.

Scope:products:read

Path parameter

storeIdstringwajib
format: uuid

Query parameter

qstringopsional
panjang maks 100

Response200 · application/json

At most 50 categories

itemsarray<CatalogCategory>wajib
Tampilkan 3 atribut turunan
- idstringwajib
- namestringwajib
- pathstringwajib
  Ancestor names joined with " > ".

Contoh request · curl

curl "https://api.comnethub.app/v1/stores/$STORE_ID/catalog/categories" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Recommend catalog category

POST/v1/stores/{storeId}/catalog/categories/recommend

Category the marketplace suggests for a product title.

Scope:products:read

Path parameter

storeIdstringwajib
format: uuid

Request bodyapplication/json

titlestringwajib
panjang min 1 · panjang maks 255

Response200 · application/json

Suggestion, or null

categoryCatalogCategorywajibnullable
Tampilkan 3 atribut turunan
- idstringwajib
- namestringwajib
- pathstringwajib
  Ancestor names joined with " > ".

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/stores/$STORE_ID/catalog/categories/recommend" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string"
}'

Get catalog category attributes

GET/v1/stores/{storeId}/catalog/categories/{categoryId}/attributes

Attributes and listing rules of a category.

Scope:products:read

Path parameter

storeIdstringwajib
format: uuid
categoryIdstringwajib
panjang maks 40

Response200 · application/json

Attributes and rules

attributesarray<CatalogAttribute>wajib
Tampilkan 7 atribut turunan
- idstringwajib
- namestringwajib
- kindstringwajib
  sales attributes define variants; product attributes describe the product.
  Salah satu dari:salesproduct
- requiredbooleanwajib
- multiplebooleanwajib
- customizablebooleanwajib
  Free-text values are allowed besides the listed ones.
- valuesarray<object>wajib
  Tampilkan 2 atribut turunan
  - idstringwajib
  - namestringwajib
rulesobjectwajib
Tampilkan 4 atribut turunan
- sizeChartRequiredbooleanwajib
- sizeChartSupportedbooleanwajib
- dimensionsRequiredbooleanwajib
- codSupportedbooleanwajib

Contoh request · curl

curl "https://api.comnethub.app/v1/stores/$STORE_ID/catalog/categories/$CATEGORY_ID/attributes" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

List catalog brands

GET/v1/stores/{storeId}/catalog/brands

Brands available for a category.

Scope:products:read

Path parameter

storeIdstringwajib
format: uuid

Query parameter

categoryIdstringopsional
panjang maks 40
qstringopsional
panjang maks 100

Response200 · application/json

Brands

itemsarray<CatalogBrand>wajib
Tampilkan 3 atribut turunan
- idstringwajib
- namestringwajib
- authorizedbooleanwajib

Contoh request · curl

curl "https://api.comnethub.app/v1/stores/$STORE_ID/catalog/brands" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

List catalog warehouses

GET/v1/stores/{storeId}/catalog/warehouses

The shop's enabled sales warehouses on the marketplace.

Scope:products:read

Path parameter

storeIdstringwajib
format: uuid

Response200 · application/json

Warehouses

itemsarray<CatalogWarehouse>wajib
Tampilkan 3 atribut turunan
- idstringwajib
- namestringwajib
- isDefaultbooleanwajib

Contoh request · curl

curl "https://api.comnethub.app/v1/stores/$STORE_ID/catalog/warehouses" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Upload catalog image

POST/v1/stores/{storeId}/catalog/images

Upload an image to the marketplace for use in a product.

Scope:products:write

Path parameter

storeIdstringwajib
format: uuid

Request bodyapplication/json

datastringwajib
Base64 image, at most 5 MB decoded.
panjang maks 7000000
filenamestringopsional
panjang maks 200
contentTypestringwajib
Salah satu dari:image/jpegimage/pngimage/webp
useCasestringwajib
Salah satu dari:MAIN_IMAGEATTRIBUTE_IMAGESIZE_CHART_IMAGE

Response201 · application/json

Uploaded

uristringwajib
panjang min 1 · panjang maks 500
urlstringopsionalnullable
panjang maks 2000

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/stores/$STORE_ID/catalog/images" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "data": "string",
  "contentType": "image/jpeg",
  "useCase": "MAIN_IMAGE"
}'

Create catalog product

POST/v1/stores/{storeId}/catalog/products

Create a product on the marketplace; the product sync picks it up.

Scope:products:write

Path parameter

storeIdstringwajib
format: uuid

Request bodyapplication/json

titlestringwajib
panjang min 1 · panjang maks 255
descriptionstringwajib
HTML.
panjang min 1 · panjang maks 20000
categoryIdstringwajib
panjang min 1 · panjang maks 40
categoryPathstringopsionalnullable
panjang maks 500
brandIdstringopsionalnullable
panjang maks 40
imagesarray<CatalogImage>wajib
item min 1 · item maks 9
Tampilkan 2 atribut turunan
- uristringwajib
  panjang min 1 · panjang maks 500
- urlstringopsionalnullable
  panjang maks 2000
sizeChartCatalogImageopsionalnullable
Tampilkan 2 atribut turunan
- uristringwajib
  panjang min 1 · panjang maks 500
- urlstringopsionalnullable
  panjang maks 2000
attributesarray<object>wajib
item maks 100
Tampilkan 3 atribut turunan
- idstringwajib
  panjang maks 40
- valueIdsarray<string>opsional
  item maks 50
- valuesarray<string>opsional
  item maks 50
weightKgstringwajib
pola: ^\d{1,3}(\.\d{1,3})?$
dimensionsCmobjectopsionalnullable
Tampilkan 3 atribut turunan
- lengthstringwajib
  pola: ^\d{1,4}$
- widthstringwajib
  pola: ^\d{1,4}$
- heightstringwajib
  pola: ^\d{1,4}$
codAllowedbooleanopsional
saveAsDraftbooleanopsional
Save on the marketplace as a draft instead of submitting for review.
skusarray<object>wajib
item min 1 · item maks 100
Tampilkan 5 atribut turunan
- sellerSkustringopsionalnullable
  panjang maks 50
- pricestringwajib
  pola: ^\d{1,12}(\.\d{1,2})?$
- stockintegerwajib
  min 0 · maks 99999
- warehouseIdstringopsionalnullable
  panjang maks 40
- optionsarray<object>wajib
  item maks 3
  Tampilkan 3 atribut turunan
  - namestringwajib
    panjang min 1 · panjang maks 50
  - valuestringwajib
    panjang min 1 · panjang maks 50
  - imageCatalogImageopsionalnullable
    Tampilkan 2 atribut turunan
    uristringwajib
    panjang min 1 · panjang maks 500
    urlstringopsionalnullable
    panjang maks 2000

Response201 · application/json

Created

externalProductIdstringwajib
skusarray<object>wajib
Tampilkan 2 atribut turunan
- externalSkuIdstringwajib
- sellerSkustringwajibnullable
warningsarray<string>wajib

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/stores/$STORE_ID/catalog/products" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "description": "string",
  "categoryId": "string",
  "images": [
    {
      "uri": "string"
    }
  ],
  "attributes": [
    {
      "id": "string"
    }
  ],
  "weightKg": "string",
  "skus": [
    {
      "price": "string",
      "stock": 1,
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}'

Get catalog product draft

GET/v1/stores/{storeId}/catalog/products/{externalProductId}/draft

An existing product of the shop as a draft, to list a copy.

Scope:products:read

Path parameter

storeIdstringwajib
format: uuid
externalProductIdstringwajib
panjang maks 64

Response200 · application/json

Draft

titlestringwajib
panjang min 1 · panjang maks 255
descriptionstringwajib
HTML.
panjang min 1 · panjang maks 20000
categoryIdstringwajib
panjang min 1 · panjang maks 40
categoryPathstringopsionalnullable
panjang maks 500
brandIdstringopsionalnullable
panjang maks 40
imagesarray<CatalogImage>wajib
item min 1 · item maks 9
Tampilkan 2 atribut turunan
- uristringwajib
  panjang min 1 · panjang maks 500
- urlstringopsionalnullable
  panjang maks 2000
sizeChartCatalogImageopsionalnullable
Tampilkan 2 atribut turunan
- uristringwajib
  panjang min 1 · panjang maks 500
- urlstringopsionalnullable
  panjang maks 2000
attributesarray<object>wajib
item maks 100
Tampilkan 3 atribut turunan
- idstringwajib
  panjang maks 40
- valueIdsarray<string>opsional
  item maks 50
- valuesarray<string>opsional
  item maks 50
weightKgstringwajib
pola: ^\d{1,3}(\.\d{1,3})?$
dimensionsCmobjectopsionalnullable
Tampilkan 3 atribut turunan
- lengthstringwajib
  pola: ^\d{1,4}$
- widthstringwajib
  pola: ^\d{1,4}$
- heightstringwajib
  pola: ^\d{1,4}$
codAllowedbooleanopsional
saveAsDraftbooleanopsional
Save on the marketplace as a draft instead of submitting for review.
skusarray<object>wajib
item min 1 · item maks 100
Tampilkan 5 atribut turunan
- sellerSkustringopsionalnullable
  panjang maks 50
- pricestringwajib
  pola: ^\d{1,12}(\.\d{1,2})?$
- stockintegerwajib
  min 0 · maks 99999
- warehouseIdstringopsionalnullable
  panjang maks 40
- optionsarray<object>wajib
  item maks 3
  Tampilkan 3 atribut turunan
  - namestringwajib
    panjang min 1 · panjang maks 50
  - valuestringwajib
    panjang min 1 · panjang maks 50
  - imageCatalogImageopsionalnullable
    Tampilkan 2 atribut turunan
    uristringwajib
    panjang min 1 · panjang maks 500
    urlstringopsionalnullable
    panjang maks 2000

Contoh request · curl

curl "https://api.comnethub.app/v1/stores/$STORE_ID/catalog/products/$EXTERNAL_PRODUCT_ID/draft" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Get shipping options

GET/v1/orders/{orderId}/shipping-options

Pickup slots and drop-off availability, read live from the marketplace.

Scope:orders:read

Path parameter

orderIdstringwajib
format: uuid

Response200 · application/json

Options

packageIdstringwajibnullable
pickupobjectwajib
Tampilkan 2 atribut turunan
- availablebooleanwajib
- slotsarray<object>wajib
  Tampilkan 4 atribut turunan
  - idstringwajib
  - labelstringwajib
  - startAtstringwajibnullable
    format: date-time
  - endAtstringwajibnullable
    format: date-time
dropoffobjectwajib
Tampilkan 1 atribut turunan
- availablebooleanwajib

Contoh request · curl

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

Arrange shipment

POST/v1/orders/{orderId}/ship

Arrange pickup or drop-off for the order on the marketplace.

Scope:orders:write

Path parameter

orderIdstringwajib
format: uuid

Request bodyapplication/json

methodstringwajib
Salah satu dari:pickupdropoff
slotIdstringopsional
panjang maks 100

Response204

Arranged; the order is refreshed from the marketplace

Tidak ada response body.

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/orders/$ORDER_ID/ship" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "pickup"
}'

Get shipping label

GET/v1/orders/{orderId}/shipping-label

Shipping label PDF.

Scope:orders:read

Path parameter

orderIdstringwajib
format: uuid

Response200 · application/pdf

PDF

binary

Contoh request · curl

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

List aftersale requests

GET/v1/orders/{orderId}/aftersale

Pending cancellation and return requests the seller can decide on.

Scope:orders:read

Path parameter

orderIdstringwajib
format: uuid

Response200 · application/json

Requests

itemsarray<AftersaleRequest>wajib
Tampilkan 10 atribut turunan
- externalIdstringwajib
- kindstringwajib
  Salah satu dari:cancelreturn
- typestringwajib
- statusstringwajib
- marketplaceStatusstringwajib
- reasonstringwajibnullable
- refundAmountstring (decimal)wajib
  Decimal string with two fraction digits.
- currencystringwajibnullable
- canRejectbooleanwajib
- needsReasonbooleanwajib

Contoh request · curl

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

List reject reasons

GET/v1/orders/{orderId}/aftersale/{externalId}/reject-reasons

Rejection reasons the marketplace accepts for this request.

Scope:orders:read

Path parameter

orderIdstringwajib
format: uuid
externalIdstringwajib
panjang maks 100

Response200 · application/json

Reasons

itemsarray<RejectReason>wajib
Tampilkan 2 atribut turunan
- codestringwajib
- labelstringwajib

Contoh request · curl

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

Decide aftersale

POST/v1/orders/{orderId}/aftersale/{externalId}/decision

Approve or reject a cancellation or return request.

Scope:orders:write

Path parameter

orderIdstringwajib
format: uuid
externalIdstringwajib
panjang maks 100

Request bodyapplication/json

approvebooleanwajib
reasonCodestringopsional
panjang maks 100
commentstringopsional
panjang maks 500

Response204

Sent; the order is refreshed from the marketplace

Tidak ada response body.

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/orders/$ORDER_ID/aftersale/$EXTERNAL_ID/decision" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "approve": true
}'

Bulk arrange shipment

POST/v1/bulk/orders/ship

Arrange pickup or drop-off for many orders; pickup takes the earliest offered slot.

Scope:orders:write

Request bodyapplication/json

orderIdsarray<Id>wajib
item min 1 · item maks 100
methodstringwajib
Salah satu dari:pickupdropoff

Response200 · application/json

Outcome per order, in request order

resultsarray<object>wajib
Tampilkan 3 atribut turunan
- orderIdstringwajib
  format: uuid
- okbooleanwajib
- errorobjectwajibnullable
  Tampilkan 2 atribut turunan
  - codestringwajib
  - messagestringwajib

Contoh request · curl

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

Bulk shipping labels

POST/v1/bulk/orders/labels

One PDF with the shipping labels of many orders.

Per-order outcomes are in the `x-bulk-results` response header (JSON array of BulkResult items). 422 `NO_LABELS` when none could be fetched.

Scope:orders:read

Request bodyapplication/json

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

Response200 · application/pdf

Merged PDF

binary

Contoh request · curl

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