API docs by Redocly

DPX ECOMMERCE API (202504.0.0-beta.1)

Download OpenAPI specification:

License: MIT

Product

Product management

Get a list of products

query Parameters
page
integer
Default: 1
Example: page=1

Page number

page_size
integer [ 1 .. 50 ]
Default: 10
Example: page_size=10

Number of items per page

sort_key
string
Default: "create_date"
Enum: "item_no" "product_id" "unit_price" "create_date"
Example: sort_key=create_date

Field to sort by

sort_order
string
Default: "asc"
Enum: "asc" "desc"
Example: sort_order=asc

Sort order

status
string
Default: ""
Enum: "ACTIVE" "INACTIVE" "CANCELLED" ""

FIlter by product status

item_no
string

Filter by dpx item number

product_id
string

Filter by customer product ID

header Parameters
CLIENT-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "total_items": 0,
  • "last_page": 0,
  • "current_page": 0,
  • "page_size": 0,
  • "data": [
    ]
}

Create product

header Parameters
CLIENT-ID
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Create product bundle

header Parameters
CLIENT-ID
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Update product

Update product details by item number

Only product_id, description, unit_price, brand, barcodes can be updated

path Parameters
item_no
required
string

Dpx item no

header Parameters
CLIENT-ID
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Cancel product

path Parameters
item_no
required
string

Dpx item no

header Parameters
CLIENT-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Cancel product barode

path Parameters
item_no
required
string

Dpx item no

barcode_no
required
string

Barcode number to cancel

header Parameters
CLIENT-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Asn

Advanced Shipping Notice

Create ASN

header Parameters
CLIENT-ID
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Get ASN by GR number

path Parameters
gr_number
required
string
header Parameters
CLIENT-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

cancel ASN by GR number

path Parameters
gr_number
required
string
header Parameters
CLIENT-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

confirm ASN by GR number

path Parameters
gr_number
required
string
header Parameters
CLIENT-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

update ASN by GR number

Only update arrival_datetime, reference_number, remark on status "DATA ENTRY"

path Parameters
gr_number
required
string
header Parameters
CLIENT-ID
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Inventory

Inventory management

Get inventory details

List product stocks with pagination, sorting, and filtering options

Returns a paginated list of products with their stock information including available quantity, booked quantity, and on-hand quantity.

Only non-bundle products

query Parameters
page
integer
Default: 1
Example: page=1

Page number

page_size
integer [ 1 .. 50 ]
Default: 10
Example: page_size=10

Number of items per page

sort_key
string
Default: "create_date"
Enum: "item_no" "product_id" "unit_price" "create_date"
Example: sort_key=create_date

Field to sort by

sort_order
string
Default: "asc"
Enum: "asc" "desc"
Example: sort_order=asc

Sort order

status
string
Default: "ACTIVE"
Enum: "ACTIVE" "INACTIVE" "CANCELLED" ""
Example: status=ACTIVE

FIlter by product status

item_no
string

Filter by dpx item number

product_id
string

Filter by customer product ID

header Parameters
CLIENT-ID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "total_items:": 0,
  • "last_page": 0,
  • "current_page": 0,
  • "page_size": 0,
  • "data": [
    ]
}