Trading API (1.0.20)
Download OpenAPI specification:
Team Alpha:
alpha-engineering@container-xchange.com
Description of bulk trading related public APIs
Create multiple listings
Creates multiple container listings in a single request.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
Array
|
locationUnlocode
required
|
string
|
|
containerType
required
|
string
Value:
"FORTY_HIGH_CUBE"
|
|
containerCondition
required
|
string
Enum:
"BRAND_NEW"
"CARGO_WORTHY"
"WWT"
|
|
quantity
required
|
integer
|
|
price
required
|
number
|
|
listingType
required
|
string
Enum:
"PICK_UP"
"GATE_BUY"
|
| usageType |
string
Value:
"EXPORT"
|
| source |
string
Value:
"API"
|
| depotId |
string
|
| negotiable |
boolean
|
| instant |
boolean
|
|
object
|
|
|
object
(DateRange)
|
|
|
required
|
object
(DateRange)
|
|
Array of objects
(Image)
|
|
| colors |
Array of strings
|
| lockbox |
boolean
|
| forkliftPockets |
boolean
|
| containerPrefixes |
string
|
| cscExpirationDate |
string
<date>
|
| comments |
string
|
| freeStorageDays |
integer
|
| storageFees |
number
|
Responses
Request samples
- Payload
Content type
application/json
[
-
{
-
"locationUnlocode":
"USLAX",
-
"containerType":
"FORTY_HIGH_CUBE",
-
"containerCondition":
"CARGO_WORTHY",
-
"quantity":
3,
-
"price":
1200,
-
"listingType":
"PICK_UP",
-
"usageType":
"EXPORT",
-
"yearOfManufacture":
{
-
"from":
2018,
-
"to":
2022
}
}
]
Update multiple listings
Updates multiple existing listings in bulk.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
Array
| id |
integer
|
|
locationUnlocode
required
|
string
|
|
containerType
required
|
string
Value:
"FORTY_HIGH_CUBE"
|
|
containerCondition
required
|
string
Enum:
"BRAND_NEW"
"CARGO_WORTHY"
"WWT"
|
|
quantity
required
|
integer
|
|
price
required
|
number
|
|
listingType
required
|
string
Enum:
"PICK_UP"
"GATE_BUY"
|
| usageType |
string
Value:
"EXPORT"
|
| source |
string
Value:
"API"
|
| depotId |
string
|
| negotiable |
boolean
|
| instant |
boolean
|
|
object
|
|
|
object
(DateRange)
|
|
|
required
|
object
(DateRange)
|
|
Array of objects
(Image)
|
|
| colors |
Array of strings
|
| lockbox |
boolean
|
| forkliftPockets |
boolean
|
| containerPrefixes |
string
|
| cscExpirationDate |
string
<date>
|
| comments |
string
|
| freeStorageDays |
integer
|
| storageFees |
number
|
Responses
Request samples
- Payload
Content type
application/json
[
-
{
-
"id":
0,
-
"locationUnlocode":
"string",
-
"containerType":
"FORTY_HIGH_CUBE",
-
"containerCondition":
"BRAND_NEW",
-
"quantity":
0,
-
"price":
0,
-
"listingType":
"PICK_UP",
-
"usageType":
"EXPORT",
-
"source":
"API",
-
"depotId":
"string",
-
"negotiable":
true,
-
"instant":
true,
-
"yearOfManufacture":
{
-
"from":
0,
-
"to":
0
},
-
"availabilityDateRange":
{
-
"from":
"2019-08-24",
-
"to":
"2019-08-24"
},
-
"validityDateRange":
{
-
"from":
"2019-08-24",
-
"to":
"2019-08-24"
},
-
"images":
[
-
{
-
"attachmentType":
"attachment-external",
-
"isCover":
true,
-
"base64String":
"string",
-
"name":
"string",
-
"contentType":
"string",
-
"url":
"string"
}
],
-
"colors":
[
-
"string"
],
-
"lockbox":
true,
-
"forkliftPockets":
true,
-
"containerPrefixes":
"string",
-
"cscExpirationDate":
"2019-08-24",
-
"comments":
"string",
-
"freeStorageDays":
0,
-
"storageFees":
0
}
]