api-notes.md

API NOTES

sku = sourceSku configSku = configSku

Cart

GET /cart/ - done remove "configSku": from response doc - Ok

Checkout - done

POST /checkout/init/ request: replace sourceSku -> sku currently I don't use "supplier" field and "order.items"; - no changes

response: rename idCustomerAddress -> id - done

POST /checkout/ rename paymentResult -> testPaymentResult; no sourceSku -> sku? remove ccSave - no; it used remove expiryGenerationtime - ok

response: itemCollection -> order[] same as in request - done

/checkout/summary/ not using - it used by mobile

/checkout/reorder/ - will not be reflected in api now replaced by /customer/orders/:id/reorder

Customer

rename /customer/address -> /customer/addresses/

POST /customer/address/ POST, PUT requests body naming, remove 'address' wrapper- done

change to DELETE /customer/addresses/:id/ - done

PUT looks strange. should be kind of PUT /customer/addresses/:id/ - done

POST /customer/forgot/ response instead of request - done

remove /customer/sociallogin/ or hide?- done

CMS

remove /cms It's not using by Shopgular. - no

System

not used - no /system - no /system/paymentmethods - done /system/translations - done

Cart

not used DELETE, PUT, POST - no

Suppliers

rename /supplier/ -> /suppliers/ - done

GET /suppliers/ remove "supplier" wrapper - done rename supplierId -> id

remove /supplier/{supplierId}/availabletimes - done

GET /suppliers/:id/categories/ ?depth is not used response is totally incorrect

GET /suppliers/:id/categories/:categoriId is not used

Products

GET /suppliers/:id/product/ rename to /suppliers/:id/products/ - done

don't remove filter from response we use for selection!

missed description for query params page=:number pagesize=:number q=:string filter[brand|selection|category]=:id groupsize=:number sku= is it needed? groupby=subcategory

remove showFilters=1

My account

PATCH /customer need example how to change password from old wiki

Orders

List of orders (current and delivered) GET /customer/orders/

Info about order GET /customer/orders/:id - postpone after headers auth

get list of available skus to place in cart GET /customer/orders/:id/reorder - no, it is required a lot of effort and time for backend

Payments

instead of customer/token - no

GET /customer/cards/ - no; see customer/tokens

DELETE /customer/cards/:id/ - no; see customer/token delete card add description

POST /customer/cards/ for create add description post should return single element. not a full collection

Contacts form

need endpoint for contacts form - postpone after headers auth POST /contact-us

fields are: name email phone subject message