Get Order
Developing
GET
/v1/orders/{id}
Request
Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************Path Params
id
string
required
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:8083/v1/orders/' \
--header 'x-api-key;'Responses
🟢200Success
application/json
Body
Represents the input data required for creating a fulfillment order.
id
string
required
Example:
550e8400-e29b-41d4-a716-446655440000
shipping_address
object
required
name
string
required
Example:
Elon Musk
address_1
string
required
Example:
321 Starbase Way
address_2
string
optional
Example:
Unit 42
city
string
required
Example:
Los Angeles
state
string
required
Example:
CA
country
string
required
Example:
US
postal_code
string
required
Example:
90210
phone
string
optional
Example:
310-123-4321
shipping_speed
enum<string>
required
Allowed values:
normalfastfastest
items
array [object {3}]
required
sku
string
required
Example:
BXJ117
quantity
integer
required
Example:
1
placements
array [object {2}]
required
status
enum<string>
required
Allowed values:
newawaiting_paymentpaidmanufacturingshippeddeliveredcancelledrefundedon_hold
Example
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"shipping_address": {
"name": "Elon Musk",
"address_1": "321 Starbase Way",
"address_2": "Unit 42",
"city": "Los Angeles",
"state": "CA",
"country": "US",
"postal_code": "90210",
"phone": "310-123-4321"
},
"shipping_speed": "normal",
"items": [
{
"sku": "BXJ117",
"quantity": 1,
"placements": [
{
"label": "front",
"image": {
"url": "http://.../public.jpg",
"alignment": "center",
"tile": false
}
}
]
}
],
"status": "new"
}