Professional Documents
Culture Documents
Technical Concepts
• Hosts
• Authorization
• Managing Resources
• API Errors
EU US
Merchant mc.commercetools.com mc.commercetools.co
Center
… … …
• Default is 48 hours.
"grant_type=client_credentials&scope=manage_project:${PROJECT_KEY}"
https://auth.sphere.io/oauth/token)"
Example Response
"access_token": "vkFuQ6oTwj8_Ye4eiRSsqMeqLYxxxxxx",
"scope": "manage_project:{projectKey}",
"token_type": "Bearer”
curl -s "https://api.sphere.io/${PROJECT_KEY}/product-projections?access_token=${ACCESS_TOKEN}"
https://github.com/sphereio/sphere-hello-api/blob/master/curl/hello-api
{scope}:{projectKey}
Client
Model
API Database
Client
Database
Model
API
Query Command
Read Models
API Database
Object
Object Draft
User-defined fields:
Object Draft • Key
• Name
User-defined fields: Create Object • etc.
• Key
• Name Platform-generated fields:
• etc. • Id
• Version
• Created at
• Last modified at
User-defined fields:
• orderNumber
OrderFromCartDraft • paymentState
Examples
It is a JSON object.
{
"de": "Hundefutter",
"en": "dog food”
}
Used mainly for fields: name, slug, description, and meta data fields.
A (loose) reference
{
"typeId": "product",
"id": "d1229e6f-2b79-441e-b419-180311e52754”
}
Reference types can be e.g. cart, category, channel, customer, and payment.
reference
Expanded reference
reference
Reference by Id or Key.
Id à Platform generated.
Not all resources support key currently. Examples: products, product types.
A JSON object.
{
”currencyCode": ”EUR",
”centAmount": 4200
}
A JSON string.
"2001-09-11T14:00:00.000Z"
A JSON string.
id
title
salutation
firstName
lastName
streetName
streetNumber
postalCode
region
state
country*
…
401 Unauthorized
403 Forbidden
409 Conflict
{
"statusCode": XXX, // e.g. 400
"message": "First error message",
"errors": [
{
"code":"SomeErrorCode",
"message": "First error message”
},
{
"code":"SomeErrorCode",
"message": "Second error message”
}
]
}
• Error codes:
• InvalidInput
• InvalidOperation
• InvalidField
• RequiredField
• DuplicateField
409 Conflict
}
• currentVersion is required.