api-docs/octommerce-api.apib at master · octommerce/api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
FORMAT: 1A
HOST: https://api.octommerce.com

# API Octommerce
E-commerce for multiplatform device.

## Access Token

Authorization for header:

```http
Authorization: bearer 5262d64b892e8d4341000001
```

example to get access token with form-data:

key | value
---- | -----------
grant_type  | password
client_id  | 064014261138896
client_secret  | yoq6y9lt8aaoth416ly3y1ws5dcv4eqa
username  | octommerce
password  | ********

::: note
# Notes
you can try this method with google crhome extension plugin [__POSTMAN__](https://www.getpostman.com)
:::

# Data Structures

## ImageData
+ id: 1 (required, number) - Unique identifier
+ diskname: 58ff29082e57e059107674.png
+ file_name: 2.png
+ file_size: 9574 (number)
+ content_type: image/png
+ title: null
+ description: null
+ field: images
+ sort_order: 6 (number)
+ created_at: 2017/04/25 17:46:32
+ update_at: 2017/04/25 19:48:14
+ path: http://api.octommerce.com/storage/app/uploads/public/58f/f29/082/58ff29082e57e059107674.png
+ extension: png

## ImageList (array)
+ (ImageData)

## ProductData
+ id: 1 (required, number) - Unique identifier
+ sku: 123 (required, number) - Unique identifier
+ name: Kuku bima Energi (required) - Single line description
+ description: minuman berenergi roso roso - Full description of the note which supports Markdown.
+ price: 12000 (required, number) - Unique identifier
+ sale_price: null
+ images (ImageList)

## ProductList (array)
+ (ProductData)

## ProductInclude
+ data (ProductList)


## CategoryData
+ id: 1 (required, number) - Unique identifier
+ slug: Minuman
+ name: Minuman (required) - Single line description
+ description: minuman berenergi roso roso - Full description of the note which supports Markdown.
+ images (ImageList)
+ color: null
+ keywords: roso roso

## CategoryList (array)
+ (CategoryData)

## ReviewData
+ id: 1 (required, number) - Unique identifier
+ product_id: 2 (required, number)
+ title: Mantap (required) - Single line description
+ content: hangat di tubuh - Full description of the note which supports Markdown.
+ rating : 1 (required, number)
+ is_buyer: 0 (required, number)

## ReviewList (array)
+ (ReviewData)

## BrandData
+ id: 1 (required, number) - Unique identifier
+ slug: Sidomuncul
+ name: Sidomuncul (required) - Single line description
+ description: minuman berenergi roso roso - Full description of the note which supports Markdown.
+ images (ImageList)
+ keywords: roso roso

## BrandList (array)
+ (BrandData)

## UserData
+ id: 1 (required, number) - Unique identifier
+ name: Octommerce (required) - Single line description
+ username: octommerce (required) - Single line description
+ email: octommerce@octommerce.com - Full description of the note which supports Markdown.
+ last_login: 2017/04/25 17:46:32
+ avatar: null,
+ address_count: 2 (required, number)
+ orders_count: 1 (required, number)

## UserList (array)
+ (UserData)

## OrderData
+ id: 1 (required, number) - Unique identifier
+ user_id: 2 (required, number) - Unique identifier
+ order_no: F4C5JLDHT
+ name: Octommerce (required) - Single line description
+ email: octommerce@octommerce.com
+ phone: 08887758271
+ message: null
+ subtotal: 24000 (required, number) - Unique identifier
+ discount:  0 (required, number) - Unique identifier
+ tax:  0 (required, number) - Unique identifier
+ misc_fee:  0 (required, number) - Unique identifier
+ total:  24000 (required, number) - Unique identifier
+ status_code: waiting
+ status_update_at(updateData)
+ create_at: 2017/05/04 11:16:39
+ invoices (invoiceList)
+ update_at: 2017/05/04 11:16:39

## OrderList (array)
+ (OrderData)

## AddressData
+ id: 1 (required, number) - Unique identifier
+ location_code: 32.17.07 (required) - Single line description
+ address_name: office (required) - Single line description
+ name: octommerce - Full description of the note which supports Markdown.
+ phone: 085813488273(required, number)
+ street: jalan tiga putra no 43,
+ latitude: 2.419259600000000176578396349214017391204833984375
+ longtitude: 99.5768417999999968515112414024770259857177734375
+ is_primary: 1

## AddressList (array)
+ (AddressData)


<!-- include(product-include.md) -->

<!-- include(category-include.md) -->

<!-- include(brand-include.md) -->

<!-- include(review-include.md) -->

<!-- include(user-include.md) -->

<!-- include(cart-include.md) -->

<!-- include(order-include.md) -->