https://github.com/devgurusio/commercetools-entities-schemas
Commercetools HTTP API entities schemas
https://github.com/devgurusio/commercetools-entities-schemas
api-documentation commercetools commercetools-entities-schemas ecommerce json-schema validation
Last synced: 26 days ago
JSON representation
Commercetools HTTP API entities schemas
- Host: GitHub
- URL: https://github.com/devgurusio/commercetools-entities-schemas
- Owner: Devgurusio
- Created: 2019-12-05T08:59:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:18:14.000Z (almost 2 years ago)
- Last Synced: 2025-04-22T21:17:09.095Z (26 days ago)
- Topics: api-documentation, commercetools, commercetools-entities-schemas, ecommerce, json-schema, validation
- Language: JavaScript
- Homepage: https://docs.commercetools.com/
- Size: 1.6 MB
- Stars: 7
- Watchers: 6
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# commercetools entities schemas
Reusable commercetools entities schemas definitions
## Docs
- ### baseTypes
- address
- addressDraft
- asset
- assetSource
- attribute
- baseMoney
- createdBy
- customFields
- dateTime
- image
- lastModifiedBy
- priceDraft
- reference
- resourceIdentifier
- geoJSONGeometry
- localizedString
- money
- reviewRatingStatistics
- assetDraft
- customFieldsDraft
- date
- key
- price
- slug
- ### general purpose
- message
- pagedQueryResult
- ### categories
- category
- categoryDraft
- ### channel
- channel
- channelDraft
- ### customer
- customer
- customerDraft
- customerSignInResult
- customerToken
- ### customerGroup
- customerGroup
- customerGroupDraft
- ### httpApi
- pagedQueryResult
- searchParams
- ### store
- store
- storeDraft
- ### taxCategory
- subRate
- taxCategory
- taxCategoryDraft
- taxRate
- taxRateDraft
- ### discount
- discountCode
- ### cart
- cart
- lineItem
- lineItemDraft
- ### order
- order
- orderFromCartDraft
- ### shippingMethod
- shippingMethod
## Install
```console
npm i commercetools-entities-schemas --save
```
## Usage
After adding it to your project just require the desired schemas.
You can require the specific schema you need:
```javascript
const address = require("commercetools-entities-schemas/baseTypes/address");
```
You can also require by group:
```javascript
const { address } = require("commercetools-entities-schemas/baseTypes");
```
Or get everything at once:
```javascript
const schemas = require("commercetools-entities-schemas");
const address = schemas.baseTypes.address
```