Skip to content

Commit ed2b07d

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent e3d5bc9 commit ed2b07d

File tree

74 files changed

+3356
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+3356
-0
lines changed

‎api-specs/mist/annotations.raml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#%RAML 1.0 Library
2+
usage: Generator annotation types.
3+
4+
annotationTypes:
5+
methodName:
6+
type: string
7+
package:
8+
description: |
9+
Allows to specify a target package for a generator for a RAML library.
10+
This package name should be a language indepedent logical name (e.g. "products"), which a generator then uses to
11+
generate a language-specific package name (e.g. "com.myapi.jvm.products") from its configuration.
12+
allowedTargets:
13+
- Library
14+
type: string
15+
beta:
16+
type: boolean
17+
enumDescriptions:
18+
description: |
19+
Allows to describe the values of an enum type.
20+
type: object
21+
properties:
22+
//:
23+
description: |
24+
Adds a description for the enum value given by the key.
25+
type: string
26+
products:
27+
allowedTargets:
28+
- API
29+
type: array
30+
items:
31+
type: string

‎api-specs/mist/api.raml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#%RAML 1.0
2+
---
3+
title: commercetools MIST API
4+
uses:
5+
annotations: annotations.raml
6+
(annotations.products):
7+
- InStore
8+
version: v1
9+
mediaType: application/json
10+
baseUri: https://api.nebulaterra.com
11+
types: !include types/types.raml
12+
13+
/location: !include resources/location.raml
14+
/role: !include resources/role.raml
15+
/session: !include resources/session.raml
16+
/workstation: !include resources/workstation.raml
17+
/workstations: !include resources/workstations.raml

‎api-specs/mist/examples/callbacks/cart-retrieval-response.json‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
{
2+
"location": "001",
3+
"workstation": "01",
4+
"reference": "001010500813",
5+
"customer": {
6+
"customer_number": "jr5129991111",
7+
"salutation": "",
8+
"first_name": "Jerry",
9+
"middle_name": "",
10+
"last_name": "Rightmer"
11+
},
12+
"carts": [
13+
{
14+
"id": "001010500813",
15+
"type": "sale",
16+
"transaction_line_items": [
17+
{
18+
"cart_item_id": "1ca6823d-1c7d-42ec-af4f-a93da38f1178",
19+
"item_id": "sling-bagCB20Q",
20+
"description": "Sling Bag",
21+
"quantity": 1,
22+
"price": 2895,
23+
"extended_price": 2895,
24+
"tax_code": "US",
25+
"price_modifiers": [{ "description": "discount", "amount": 579 }],
26+
"gift_receipt": false,
27+
"attributes": [{ "label": "brand", "value": "Varsity" }]
28+
}
29+
],
30+
"cart_total": 2455,
31+
"cart_origin": "commercetools",
32+
"gift_receipt": false
33+
},
34+
{
35+
"id": "001010500813",
36+
"type": "order",
37+
"transaction_line_items": [
38+
{
39+
"cart_item_id": "eff2925d-f3de-47c2-a8d4-183b3d275b8f",
40+
"item_id": "racerbacktank395795492701",
41+
"description": "Distance Lite Splice Back Tank",
42+
"quantity": 1,
43+
"price": 5000,
44+
"extended_price": 5000,
45+
"tax_code": "US",
46+
"price_modifiers": [{ "description": "discount", "amount": 1000 }],
47+
"gift_receipt": false,
48+
"attributes": [
49+
{ "label": "size", "value": "M" },
50+
{ "label": "color", "value": "Dark Blue" },
51+
{ "label": "brand", "value": "Peloton" }
52+
]
53+
}
54+
],
55+
"cart_total": 4240,
56+
"cart_origin": "commercetools",
57+
"gift_receipt": false
58+
}
59+
],
60+
"currency": "USD",
61+
"locale": "en-US",
62+
"total_gross": 8815,
63+
"total_net": 8316,
64+
"total_tax": 499,
65+
"total_saved": 1579,
66+
"tax_included_in_price": false,
67+
"tax_summary": [
68+
{
69+
"code": "US",
70+
"total_net": 8317,
71+
"total_gross": 8816,
72+
"tax_rate": 6,
73+
"total_tax": 499,
74+
"tax_included_in_price": false
75+
}
76+
]
77+
}

‎api-specs/mist/examples/callbacks/item-attribute.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "brand",
3+
"value": "Varsity"
4+
}

‎api-specs/mist/examples/callbacks/price-modifier.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"description": "discount",
3+
"amount": 579
4+
}

‎api-specs/mist/examples/callbacks/return-cart-retrieval-response.json‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
{
2+
"location": "001",
3+
"workstation": "01",
4+
"reference": "001010499453",
5+
"carts": [
6+
{
7+
"id": "001010150829",
8+
"type": "return",
9+
"transaction_line_items": [
10+
{
11+
"cart_item_id": "6a35471a-0021-4cc6-978d-22ee6dfe7798",
12+
"item_id": "90s-jeans",
13+
"description": "Super High Waisted Light Wash Front Seam 90s Slim Jeans",
14+
"quantity": 1,
15+
"price": 5600,
16+
"extended_price": 5600,
17+
"tax_code": "US",
18+
"price_modifiers": [{ "description": "discount", "amount": 1120 }],
19+
"gift_receipt": false,
20+
"attributes": [
21+
{ "label": "size", "value": "2" },
22+
{ "label": "color", "value": "Light Wash" },
23+
{ "label": "brand", "value": "Express" }
24+
],
25+
"original_line_id": "3f19705f-f89e-46c6-99bf-0b511c0edbbc",
26+
"return_reason": "Wrong size"
27+
}
28+
],
29+
"tender_line_items": [
30+
{
31+
"tender_type": "Credit",
32+
"amount": 10158,
33+
"currency": "USD",
34+
"processor": "Stripe",
35+
"processor_id": "pi_3OD88AC24rtrkoWS1yMbPozG",
36+
"last4": "4242",
37+
"brand": "visa",
38+
"account_type": "credit",
39+
"application_preferred_name": "",
40+
"dedicated_file_name": "",
41+
"authorization_response_code": "3030",
42+
"application_cryptogram": "",
43+
"terminal_verification_results": "",
44+
"transaction_status_information": "",
45+
"refunded": 0
46+
}
47+
],
48+
"cart_total": 4838,
49+
"cart_origin": "commercetools",
50+
"gift_receipt": false
51+
},
52+
{
53+
"id": "unknown",
54+
"type": "return",
55+
"transaction_line_items": [
56+
{
57+
"cart_item_id": "7b3313d6-2c28-4ec1-8859-31911a3d0bf2",
58+
"item_id": "davidoffcoolwater2493205",
59+
"description": "Davidoff Cool Water for Men Eau De Toilette Spray 125mL",
60+
"quantity": 1,
61+
"price": 2565,
62+
"extended_price": 2565,
63+
"tax_code": "US",
64+
"price_modifiers": [],
65+
"gift_receipt": false,
66+
"attributes": [{ "label": "brand", "value": "Davidoff" }],
67+
"original_line_id": "unknown",
68+
"return_reason": "no_longer_needed"
69+
}
70+
],
71+
"tender_line_items": [],
72+
"cart_total": 2719,
73+
"cart_origin": "commercetools",
74+
"gift_receipt": false
75+
}
76+
],
77+
"currency": "USD",
78+
"locale": "en-US",
79+
"total_gross": 7468,
80+
"total_net": 7045,
81+
"total_tax": 423,
82+
"total_saved": 0,
83+
"tax_included_in_price": false,
84+
"tax_summary": [
85+
{
86+
"code": "US",
87+
"total_net": 7050,
88+
"total_gross": 7473,
89+
"tax_rate": 6,
90+
"total_tax": 423,
91+
"tax_included_in_price": false
92+
}
93+
]
94+
}

‎api-specs/mist/examples/callbacks/token-retrieval-response.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiJKV1IiLCJ0ZW5hbnRfaWQiOiJkNDM4LTZlNjgtNGMwMC0zYzYxIiwic2Vzc2lvbl9pZCI6InRyYW5zaWVudCIsInNjb3BlcyI6WyJjYXNoaW4iLCJwYXltZW50Iiwic2FmZWRlcG9zaXQiLCJkZXZpY2VtYW5hZ2VtZW50IiwiY2FzaG91dCIsInJlZnVuZCIsImNhc2hjb3VudCIsInRyYW5zZmVyaW4iLCJjYXNoYXVkaXQiLCJ0cmFuc2Zlcm91dCIsImJhbmtkZXBvc2l0IiwicmVwcmludCJdLCJ1c2VyX2lkIjoiSldSIiwiaWF0IjoxNzAxMDU0MjM1LCJleHAiOjE3MDEwOTc0MzV9.y0aKUzaDHA5t7--OzhIlMOz2XucCPoYwM8yVmQFS4uw"
3+
}

‎api-specs/mist/examples/locations/location.json‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"__v": 0,
3+
"_id": "601b651e291fbe4692a3a876",
4+
"address_line_1": "123133",
5+
"address_line_2": "45677",
6+
"aliases": null,
7+
"alternate_currencies": null,
8+
"card_payment_provider": "Simulator",
9+
"gift_card_processor": "None",
10+
"citcon_token": "A59EC58D",
11+
"city": null,
12+
"country": "USA",
13+
"created_at": "2021-02-04T03:08:14.634Z",
14+
"description": "Barton Creek Mall",
15+
"locale": "en-US",
16+
"location_id": "002",
17+
"location_name": "Store 002",
18+
"parameters": "JL Params",
19+
"postal_code": "7875491",
20+
"safe_id": "03",
21+
"state": "",
22+
"status": "active",
23+
"supported_languages": null,
24+
"telephone_number": null,
25+
"templates": "JL templates",
26+
"tenant_id": "b12c-caf4-37e0-94a1",
27+
"type": "01",
28+
"updated_at": "2023-05-25T04:58:31.962Z",
29+
"wallet_processor": "Citcon"
30+
}

0 commit comments

Comments
 (0)