Skip to content

Commit 03a1a1f

Browse files
committed
add code and status to line item error documentation
1 parent 6cb551d commit 03a1a1f

File tree

1 file changed

+41
-35
lines changed

1 file changed

+41
-35
lines changed

docs/source/includes/_line_items.md

Lines changed: 41 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -13,35 +13,35 @@ curl "https://example.com/api/v2/line_items"
1313

1414
```json
1515
{
16-
"data" : {
17-
"attributes" : {
18-
"additional_tax_total" : "0",
19-
"adjustment_total" : "0.0",
20-
"amount" : "10.0",
21-
"cost_price" : "17.0",
22-
"currency" : "CAD",
23-
"display_amount" : "$10.00 CAD",
24-
"display_price" : "$10.00 CAD",
25-
"display_total" : "$10.00 CAD",
26-
"order_id" : 1,
27-
"price" : "10.0",
28-
"quantity" : 1,
29-
"total" : "10.0",
30-
"variant_id" : 1
16+
"data": {
17+
"attributes": {
18+
"additional_tax_total": "0",
19+
"adjustment_total": "0.0",
20+
"amount": "10.0",
21+
"cost_price": "17.0",
22+
"currency": "CAD",
23+
"display_amount": "$10.00 CAD",
24+
"display_price": "$10.00 CAD",
25+
"display_total": "$10.00 CAD",
26+
"order_id": 1,
27+
"price": "10.0",
28+
"quantity": 1,
29+
"total": "10.0",
30+
"variant_id": 1
3131
},
32-
"relationships" : {
33-
"order" : {
34-
"data" : {
35-
"type" : "spree_orders"
32+
"relationships": {
33+
"order": {
34+
"data": {
35+
"type": "spree_orders"
3636
}
3737
},
38-
"variant" : {
39-
"data" : {
40-
"type" : "spree_variants"
38+
"variant": {
39+
"data": {
40+
"type": "spree_variants"
4141
}
4242
}
4343
},
44-
"type" : "spree_line_items"
44+
"type": "spree_line_items"
4545
}
4646
}
4747
```
@@ -63,11 +63,13 @@ curl "https://example.com/api/v2/line_items"
6363

6464
```json
6565
{
66-
"errors" : [
66+
"errors": [
6767
{
68-
"detail" : "Quantity is too High",
69-
"meta" : {},
70-
"title" : "The quantity that you have submitted is astronomically high, please tone it down a bit."
68+
"code": "400",
69+
"detail": "Quantity is too High",
70+
"meta": {},
71+
"status": "Bad Request",
72+
"title": "The quantity that you have submitted is astronomically high, please tone it down a bit."
7173
}
7274
]
7375
}
@@ -90,11 +92,13 @@ curl "https://example.com/api/v2/line_items"
9092

9193
```json
9294
{
93-
"errors" : [
95+
"errors": [
9496
{
95-
"detail" : "Record Not Found",
96-
"meta" : {},
97-
"title" : "One of the records that you were looking for could not be found. Please check to see if the record exists or if you're permitted to read it"
97+
"code": "400",
98+
"detail": "Record Not Found",
99+
"meta": {},
100+
"status": "Bad Request",
101+
"title": "One of the records that you were looking for could not be found. Please check to see if the record exists or if you're permitted to read it"
98102
}
99103
]
100104
}
@@ -118,11 +122,13 @@ curl "https://example.com/api/v2/line_items"
118122

119123
```json
120124
{
121-
"errors" : [
125+
"errors": [
122126
{
123-
"detail" : "Product is out of Stock",
124-
"meta" : {},
125-
"title" : "This product is out of stock for the selected quantity."
127+
"code": "400",
128+
"detail": "Product is out of Stock",
129+
"meta": {},
130+
"status": "Bad Request",
131+
"title": "This product is out of stock for the selected quantity."
126132
}
127133
]
128134
}

0 commit comments

Comments
 (0)