LCSC API Instruction

Products

Operations related to products.

Category API

This API responds all the item categories at LCSC including categories and subcategories.

query Parameters
key
required
string

API key

nonce
required
string

16-bit random string

signature
required
string

Signature

timestamp
required
string

Request timestamp

Responses

Manufacturer API

This API responds all the information of manufacturers at LCSC.

query Parameters
key
required
string

API key

nonce
required
string

16-bit random string

signature
required
string

Signature

timestamp
required
string

Request timestamp

Responses

Categorical Item List API

This API responds all the required item lists. If it calls for category item list, then will response all items lists of all the subcategories in this category.

query Parameters
category_id
required
integer <int32>

Category ID

currency
string

currency, available for AUD/CAD/EUR/JPY/RUB/SEK/GBP/DKK/HKD/SGD/USD (Default value : USD)

current_page
integer <int32>

Current page. (Default value : 1)

is_available
boolean

Only back to item in-stock. (Default value : false)

is_pre_sale
boolean

back pre order product. (Default value : true)

key
required
string

API key

nonce
required
string

16-bit random string

page_size
integer <int32>

Page Size. (Default value : 100)

signature
required
string

Signature

timestamp
required
string

Request timestamp

user_type
integer <int32>

When it is 2, only the product ID, lcsc_part_number and quantity are returned. (Default value : 1)

Responses

Item Details API

This API responds all the detailed information of items.

query Parameters
key
required
string

API key

nonce
required
string

16-bit random string

product_number
required
string

Product Number

signature
required
string

Signature

timestamp
required
string

Request timestamp

Responses

Keyword Search List API

Search parts by keyword and returns a maximum of 30 parts per page. Keyword matches LCSC part number, mpn, category, manufacturer, It works best with LCSC part numbers as some manufacturers overlap other manufacturer part numbers.

query Parameters
current_page
integer <int32>

Current page (Default value : 1)

is_available
boolean

Only back to item in-stock (Default value : false)

is_pre_sale
boolean

Only back to item is-pre-sale (Default value : false)

key
required
string

API key

keyword
required
string

Sku/MPN/Category/Manufacturer

match_type
string
  • For exact search on the mpn field, use the exact parameter.
  • For fuzzy search on the mpn field, use the fuzzy parameter. (Default value : exact)
nonce
required
string

16-bit random string

page_size
integer <int32>

Page size (Default value : 100)

signature
required
string

Signature

timestamp
required
string

Request timestamp

Responses

Orders

Managing customer orders.

Order Create API

This API can create order.

Request Body schema: application/json
required

reqVO

key
required
string

API key

nonce
required
string

16-bit random string

ordernum
string

ordernum

required
Array of objects (AgentOrderProductPO)

order product item: pros=[{"Pro":"C2653","Qty":5},{"Pro":"C175459","Qty":80}]

signature
required
string

Signature

timestamp
required
string

Request timestamp

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "nonce": "string",
  • "ordernum": "string",
  • "pros": [
    ],
  • "signature": "string",
  • "timestamp": "string"
}

Check Order API

This API responds the orderCodes or poOrderCodes with a maximum of 10 provided by the dealer to query your own order details. The orderCodes conditions take precedence over the poOrderCodes conditions when they are both present.

query Parameters
key
required
string

API key

nonce
required
string

16-bit random string

orderCodes
Array of strings

Order Codes - A collection of orderCodes with a maximum quantity of 10

poOrderCodes
Array of strings

PO number - A collection of poOrderCodes(user-defined PO number) with a maximum quantity of 10

signature
required
string

Signature

timestamp
required
string

Request timestamp

Responses

Shipment

Managing customer address.

Get Shipment API

This API responds all shipment methods based on items and country in your request

Request Body schema: application/json
required

reqVO

countryCode
string

country of your shipping address:"US"

key
required
string

API key

nonce
required
string

16-bit random string

required
Array of objects (AgentOrderProductPO)

product items:pros=[{"Pro:"C2653","Qty":5},{"Pro:"C175459","Qty":80}]

signature
required
string

Signature

state
string

country of your shipping address:"Washington"

timestamp
required
string

Request timestamp

Responses

Request samples

Content type
application/json
{
  • "countryCode": "string",
  • "key": "string",
  • "nonce": "string",
  • "pros": [
    ],
  • "signature": "string",
  • "state": "string",
  • "timestamp": "string"
}