Created
June 23, 2025 10:39
-
-
Save bartvollebregt/143d69bf84d553380cfc2d6f6168cfad to your computer and use it in GitHub Desktop.
json-schema-commercetools
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "/{projectKey}": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {} | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/api-clients": { | |
| "description": {}, | |
| "get": { | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "count", | |
| "limit", | |
| "offset", | |
| "results" | |
| ], | |
| "properties": { | |
| "limit": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "offset": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "count": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "name", | |
| "scope" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "scope": { | |
| "type": "string" | |
| }, | |
| "secret": { | |
| "type": "string" | |
| }, | |
| "lastUsedAt": { | |
| "type": "string", | |
| "format": "date-only" | |
| }, | |
| "deleteAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "createdAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "accessTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "refreshTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "scope" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "scope": { | |
| "type": "string" | |
| }, | |
| "deleteDaysAfterCreation": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "accessTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "refreshTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "responses": { | |
| "201": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "name", | |
| "scope" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "scope": { | |
| "type": "string" | |
| }, | |
| "secret": { | |
| "type": "string" | |
| }, | |
| "lastUsedAt": { | |
| "type": "string", | |
| "format": "date-only" | |
| }, | |
| "deleteAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "createdAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "accessTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "refreshTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/api-clients/{ID}": { | |
| "get": { | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "name", | |
| "scope" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "scope": { | |
| "type": "string" | |
| }, | |
| "secret": { | |
| "type": "string" | |
| }, | |
| "lastUsedAt": { | |
| "type": "string", | |
| "format": "date-only" | |
| }, | |
| "deleteAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "createdAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "accessTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "refreshTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "name", | |
| "scope" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "scope": { | |
| "type": "string" | |
| }, | |
| "secret": { | |
| "type": "string" | |
| }, | |
| "lastUsedAt": { | |
| "type": "string", | |
| "format": "date-only" | |
| }, | |
| "deleteAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "createdAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "accessTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "refreshTokenValiditySeconds": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/business-units": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "key", | |
| "name", | |
| "unitType" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "Active", | |
| "Inactive" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Active": "The Business Unit can be used in Carts, Orders, Quote Requests, and Quotes and can be edited.n", | |
| "Inactive": "The Business Unit cannot be used in Carts, Orders, Quote Requests, and Quotes and can only be edited using the [general endpoint](/../api/associates-overview#through-the-general-endpoints).n Status doesn't affect inheritance. Even if a parent unit is inactive, its children remain active and can inherit role assignments.n" | |
| } | |
| }, | |
| "stores": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "storeMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "FromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "Stores are defined on the Business Unit.n", | |
| "FromParent": "Stores are inherited from the closest parent in the hierarchy that has Stores defined.n" | |
| } | |
| }, | |
| "unitType": { | |
| "type": "string", | |
| "enum": [ | |
| "Company", | |
| "Division" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Company": "Top-level Business Unit. Must not have a `parentUnit` defined.n", | |
| "Division": "Business Unit with a `parentUnit` reference to a [Company](ctp:api:type:Division) or another Division.n" | |
| } | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "contactEmail": { | |
| "type": "string" | |
| }, | |
| "associateMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "ExplicitAndFromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "All Associates of a Business Unit must be explicitly assigned. The Business Unit cannot inherit Associates from a parent.n", | |
| "ExplicitAndFromParent": "Associates of a Business Unit can be assigned explicitly and inherited from a parent.n" | |
| } | |
| }, | |
| "associates": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRoleAssignments", | |
| "customer" | |
| ], | |
| "properties": { | |
| "associateRoleAssignments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRole" | |
| ], | |
| "properties": { | |
| "associateRole": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "inheritance": { | |
| "type": "string", | |
| "enum": [ | |
| "Enabled", | |
| "Disabled" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Enabled": "The assignment can be inherited by child Business Units.n", | |
| "Disabled": "The assignment cannot be inherited by child Business Units.n" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "Admin", | |
| "Buyer" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-deprecated": true, | |
| "x-annotation-enumDescriptions": { | |
| "Admin": "The Associate can update the Business Unit, create child Business Units and add or remove other Associates.n", | |
| "Buyer": "The Associate can make purchases on behalf of the Business Unit.n" | |
| } | |
| } | |
| }, | |
| "customer": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "approvalRuleMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "ExplicitAndFromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "Approval Rules of a Business Unit must be explicitly assigned. The Business Unit cannot inherit Approval Rules from a parent.n", | |
| "ExplicitAndFromParent": "Approval Rules of a Business Unit are inherited from a parent and can also be explicitly assigned.n" | |
| } | |
| }, | |
| "addresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "country" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "salutation": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "streetName": { | |
| "type": "string" | |
| }, | |
| "streetNumber": { | |
| "type": "string" | |
| }, | |
| "additionalStreetInfo": { | |
| "type": "string" | |
| }, | |
| "postalCode": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "company": { | |
| "type": "string" | |
| }, | |
| "department": { | |
| "type": "string" | |
| }, | |
| "building": { | |
| "type": "string" | |
| }, | |
| "apartment": { | |
| "type": "string" | |
| }, | |
| "pOBox": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "mobile": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "additionalAddressInfo": { | |
| "type": "string" | |
| }, | |
| "externalId": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "shippingAddresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "defaultShippingAddress": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "billingAddresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "defaultBillingAddress": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/business-units/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/business-units/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/approval-flows": { | |
| "description": {}, | |
| "get": {} | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/approval-flows/{ID}": { | |
| "get": {}, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/approval-rules": { | |
| "description": {}, | |
| "get": {}, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "approvers", | |
| "name", | |
| "predicate", | |
| "requesters", | |
| "status" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "Active", | |
| "Inactive" | |
| ], | |
| "x-annotation-package": "ApprovalRule", | |
| "x-annotation-enumDescriptions": { | |
| "Active": "The Approval Rule is in effect and will be used in evaluating approval requests for [Orders](ctp:api:type:Order).n", | |
| "Inactive": "The Approval Rule is not in effect and will not be used in evaluating approval requests for Orders.n" | |
| } | |
| }, | |
| "predicate": { | |
| "type": "string" | |
| }, | |
| "approvers": { | |
| "type": "object", | |
| "required": [ | |
| "tiers" | |
| ], | |
| "properties": { | |
| "tiers": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "and" | |
| ], | |
| "properties": { | |
| "and": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "or" | |
| ], | |
| "properties": { | |
| "or": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRole" | |
| ], | |
| "properties": { | |
| "associateRole": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "requesters": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRole" | |
| ], | |
| "properties": { | |
| "associateRole": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/approval-rules/key={key}": { | |
| "get": {}, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/approval-rules/{ID}": { | |
| "get": {}, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": {} | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate": { | |
| "post": {} | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "version" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "cart": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "orderNumber": { | |
| "type": "string" | |
| }, | |
| "purchaseOrderNumber": { | |
| "type": "string" | |
| }, | |
| "paymentState": { | |
| "type": "string", | |
| "enum": [ | |
| "BalanceDue", | |
| "Failed", | |
| "Pending", | |
| "CreditOwed", | |
| "Paid" | |
| ], | |
| "x-annotation-package": "Order", | |
| "x-annotation-enumDescriptions": { | |
| "BalanceDue": "Indicates that payment balance is due for the Order.n", | |
| "Failed": "Indicates that payment for the Order has failed.n", | |
| "Pending": "Indicates that payment for the Order is pending.n", | |
| "CreditOwed": "Indicates that payment for the Order is made on a credit basis.n", | |
| "Paid": "Indicates that the Order is paid for.n" | |
| } | |
| }, | |
| "shipmentState": { | |
| "type": "string", | |
| "enum": [ | |
| "Shipped", | |
| "Delivered", | |
| "Ready", | |
| "Pending", | |
| "Delayed", | |
| "Partial", | |
| "Backorder", | |
| "Canceled" | |
| ], | |
| "x-annotation-package": "Order", | |
| "x-annotation-enumDescriptions": { | |
| "Shipped": "Indicates that the Order is shipped.n", | |
| "Delivered": "Indicates that the Order is delivered.n", | |
| "Ready": "Indicates that the Order is ready to be shipped.n", | |
| "Pending": "Indicates that the shipment of the Order is pending.n", | |
| "Delayed": "Indicates that the shipment of the Order is delayed.n", | |
| "Partial": "Indicates that items in the Order are shipped in more than one shipment.n", | |
| "Backorder": "Indicates that items in the Order are not in stock and will be delivered once the items are restocked.n", | |
| "Canceled": "Indicates that the shipment of the Order is canceled.n" | |
| } | |
| }, | |
| "orderState": { | |
| "type": "string", | |
| "enum": [ | |
| "Open", | |
| "Confirmed", | |
| "Complete", | |
| "Cancelled" | |
| ], | |
| "x-annotation-package": "Order", | |
| "x-annotation-enumDescriptions": { | |
| "Open": "The default state of a new Order.n", | |
| "Confirmed": "Indicates that the Order is accepted and being processed.n", | |
| "Complete": "Indicates that the Order is fulfilled.n", | |
| "Cancelled": "Indicates that the Order is canceled.n" | |
| } | |
| }, | |
| "state": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/order-number={orderNumber}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes": { | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "quote", | |
| "version" | |
| ], | |
| "properties": { | |
| "quote": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "quoteStateToAccepted": { | |
| "type": "boolean" | |
| }, | |
| "orderNumber": { | |
| "type": "string" | |
| }, | |
| "paymentState": { | |
| "type": "string", | |
| "enum": [ | |
| "BalanceDue", | |
| "Failed", | |
| "Pending", | |
| "CreditOwed", | |
| "Paid" | |
| ], | |
| "x-annotation-package": "Order", | |
| "x-annotation-enumDescriptions": { | |
| "BalanceDue": "Indicates that payment balance is due for the Order.n", | |
| "Failed": "Indicates that payment for the Order has failed.n", | |
| "Pending": "Indicates that payment for the Order is pending.n", | |
| "CreditOwed": "Indicates that payment for the Order is made on a credit basis.n", | |
| "Paid": "Indicates that the Order is paid for.n" | |
| } | |
| }, | |
| "shipmentState": { | |
| "type": "string", | |
| "enum": [ | |
| "Shipped", | |
| "Delivered", | |
| "Ready", | |
| "Pending", | |
| "Delayed", | |
| "Partial", | |
| "Backorder", | |
| "Canceled" | |
| ], | |
| "x-annotation-package": "Order", | |
| "x-annotation-enumDescriptions": { | |
| "Shipped": "Indicates that the Order is shipped.n", | |
| "Delivered": "Indicates that the Order is delivered.n", | |
| "Ready": "Indicates that the Order is ready to be shipped.n", | |
| "Pending": "Indicates that the shipment of the Order is pending.n", | |
| "Delayed": "Indicates that the shipment of the Order is delayed.n", | |
| "Partial": "Indicates that items in the Order are shipped in more than one shipment.n", | |
| "Backorder": "Indicates that items in the Order are not in stock and will be delivered once the items are restocked.n", | |
| "Canceled": "Indicates that the shipment of the Order is canceled.n" | |
| } | |
| }, | |
| "orderState": { | |
| "type": "string", | |
| "enum": [ | |
| "Open", | |
| "Confirmed", | |
| "Complete", | |
| "Cancelled" | |
| ], | |
| "x-annotation-package": "Order", | |
| "x-annotation-enumDescriptions": { | |
| "Open": "The default state of a new Order.n", | |
| "Confirmed": "Indicates that the Order is accepted and being processed.n", | |
| "Complete": "Indicates that the Order is fulfilled.n", | |
| "Cancelled": "Indicates that the Order is canceled.n" | |
| } | |
| }, | |
| "state": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quote-requests": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": {} | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quote-requests/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quote-requests/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quotes": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quotes/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quotes/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/shopping-lists": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "slug": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "customer": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "anonymousId": { | |
| "type": "string" | |
| }, | |
| "deleteDaysAfterLastModification": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "lineItems": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "productId": { | |
| "type": "string" | |
| }, | |
| "variantId": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "sku": { | |
| "type": "string" | |
| }, | |
| "addedAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| } | |
| } | |
| } | |
| }, | |
| "textLineItems": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "addedAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| } | |
| } | |
| } | |
| }, | |
| "store": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "businessUnit": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/shopping-lists/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/shopping-lists/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/associate-roles": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "key" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "buyerAssignable": { | |
| "type": "boolean" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "AddChildUnits", | |
| "UpdateAssociates", | |
| "UpdateBusinessUnitDetails", | |
| "UpdateParentUnit", | |
| "ViewMyCarts", | |
| "ViewOthersCarts", | |
| "UpdateMyCarts", | |
| "UpdateOthersCarts", | |
| "CreateMyCarts", | |
| "CreateOthersCarts", | |
| "DeleteMyCarts", | |
| "DeleteOthersCarts", | |
| "ViewMyOrders", | |
| "ViewOthersOrders", | |
| "UpdateMyOrders", | |
| "UpdateOthersOrders", | |
| "CreateMyOrdersFromMyCarts", | |
| "CreateMyOrdersFromMyQuotes", | |
| "CreateOrdersFromOthersCarts", | |
| "CreateOrdersFromOthersQuotes", | |
| "ViewMyQuotes", | |
| "ViewOthersQuotes", | |
| "AcceptMyQuotes", | |
| "AcceptOthersQuotes", | |
| "DeclineMyQuotes", | |
| "DeclineOthersQuotes", | |
| "RenegotiateMyQuotes", | |
| "RenegotiateOthersQuotes", | |
| "ReassignMyQuotes", | |
| "ReassignOthersQuotes", | |
| "ViewMyQuoteRequests", | |
| "ViewOthersQuoteRequests", | |
| "UpdateMyQuoteRequests", | |
| "UpdateOthersQuoteRequests", | |
| "CreateMyQuoteRequestsFromMyCarts", | |
| "CreateQuoteRequestsFromOthersCarts", | |
| "CreateApprovalRules", | |
| "UpdateApprovalRules", | |
| "UpdateApprovalFlows", | |
| "ViewMyShoppingLists", | |
| "ViewOthersShoppingLists", | |
| "UpdateMyShoppingLists", | |
| "UpdateOthersShoppingLists", | |
| "CreateMyShoppingLists", | |
| "CreateOthersShoppingLists", | |
| "DeleteMyShoppingLists", | |
| "DeleteOthersShoppingLists" | |
| ], | |
| "x-annotation-package": "AssociateRole", | |
| "x-annotation-enumDescriptions": { | |
| "AddChildUnits": "An Associate can create a child Business Unit.n", | |
| "UpdateAssociates": "An Associate can manage other Associates.n", | |
| "UpdateBusinessUnitDetails": "An Associate can edit Business Unit details.n", | |
| "UpdateParentUnit": "An Associate can assign a Business Unit to be the parent unit. Additionally, the Associate requires the `AddChildUnits` permission in the new parent to perform the assignment.n", | |
| "CreateMyCarts": "An Associate can create their own B2B Carts.n", | |
| "CreateOthersCarts": "An Associate can create B2B Carts that belong to other Associates.n", | |
| "DeleteMyCarts": "An Associate can delete their own B2B Carts.n", | |
| "DeleteOthersCarts": "An Associate can delete B2B Carts that belong to other Associates.n", | |
| "UpdateMyCarts": "An Associate can update their own B2B Carts.n", | |
| "UpdateOthersCarts": "An Associate can update B2B Carts that belong to other Associates.n", | |
| "ViewMyCarts": "An Associate can view their own B2B Carts.n", | |
| "ViewOthersCarts": "An Associate can view B2B Carts that belong to other Associates.n", | |
| "CreateMyOrdersFromMyCarts": "An Associate can create Orders from their own B2B Carts.n", | |
| "CreateOrdersFromOthersCarts": "An Associate can create Orders from B2B Carts that belong to other Associates.n", | |
| "CreateMyOrdersFromMyQuotes": "An Associate can create Orders from their own B2B Quotes.n", | |
| "CreateOrdersFromOthersQuotes": "An Associate can create Orders from B2B Quotes that belong to other Associates.n", | |
| "UpdateMyOrders": "An Associate can update their own B2B Orders.n", | |
| "UpdateOthersOrders": "An Associate can update B2B Orders that belong to other Associates.n", | |
| "ViewMyOrders": "An Associate can view their own B2B Orders.n", | |
| "ViewOthersOrders": "An Associate can view B2B Orders that belong to other Associates.n", | |
| "AcceptMyQuotes": "An Associate can accept their own B2B Quotes.n", | |
| "AcceptOthersQuotes": "An Associate can accept B2B Quotes that belong to other Associates.n", | |
| "DeclineMyQuotes": "An Associate can decline their own B2B Quotes.n", | |
| "DeclineOthersQuotes": "An Associate can decline B2B Quotes that belong to other Associates.n", | |
| "RenegotiateMyQuotes": "An Associate can renegotiate their own B2B Quotes.n", | |
| "RenegotiateOthersQuotes": "An Associate can renegotiate B2B Quotes that belong to other Associates.n", | |
| "ReassignMyQuotes": "An Associate can reassign their own B2B Quotes to a different Associate.n", | |
| "ReassignOthersQuotes": "An Associate can reassign B2B Quotes that belong to other Associates.n", | |
| "ViewMyQuotes": "An Associate can view their own B2B Quotes.n", | |
| "ViewOthersQuotes": "An Associate can view B2B Quotes that belong to other Associates.n", | |
| "CreateMyQuoteRequestsFromMyCarts": "An Associate can create their own Quote Requests from their own B2B Carts.n", | |
| "CreateQuoteRequestsFromOthersCarts": "An Associate can create Quote Requests from B2B Carts that belong to other Associates.n", | |
| "UpdateMyQuoteRequests": "An Associate can update their own B2B Quote Requests.n", | |
| "UpdateOthersQuoteRequests": "An Associate can update B2B Quote Requests of other Associates.n", | |
| "ViewMyQuoteRequests": "An Associate can view their own B2B Quote Requests.n", | |
| "ViewOthersQuoteRequests": "An Associate can view B2B Quote Requests that belong to other Associates.n", | |
| "CreateApprovalRules": "An Associate can create Approval Rules.n", | |
| "UpdateApprovalRules": "An Associate can update Approval Rules.n", | |
| "UpdateApprovalFlows": "An Associate can update Approval Flows.n", | |
| "CreateMyShoppingLists": "An Associate can create their own B2B Shopping Lists.n", | |
| "CreateOthersShoppingLists": "An Associate can create B2B Shopping Lists that belong to other Associates.n", | |
| "DeleteMyShoppingLists": "An Associate can delete their own B2B Shopping Lists.n", | |
| "DeleteOthersShoppingLists": "An Associate can delete B2B Shopping Lists that belong to other Associates.n", | |
| "UpdateMyShoppingLists": "An Associate can update their own B2B Shopping Lists.n", | |
| "UpdateOthersShoppingLists": "An Associate can update B2B Shopping Lists that belong to other Associates.n", | |
| "ViewMyShoppingLists": "An Associate can view their own B2B Shopping Lists.n", | |
| "ViewOthersShoppingLists": "An Associate can view B2B Shopping Lists that belong to other Associates.n" | |
| }, | |
| "x-annotation-enumGroups": { | |
| "AddChildUnits": "Business Unit Permissions", | |
| "UpdateAssociates": "Business Unit Permissions", | |
| "UpdateBusinessUnitDetails": "Business Unit Permissions", | |
| "UpdateParentUnit": "Business Unit Permissions", | |
| "ViewMyCarts": "Cart Permissions", | |
| "ViewOthersCarts": "Cart Permissions", | |
| "UpdateMyCarts": "Cart Permissions", | |
| "UpdateOthersCarts": "Cart Permissions", | |
| "CreateMyCarts": "Cart Permissions", | |
| "CreateOthersCarts": "Cart Permissions", | |
| "DeleteMyCarts": "Cart Permissions", | |
| "DeleteOthersCarts": "Cart Permissions", | |
| "ViewMyOrders": "Order Permissions", | |
| "ViewOthersOrders": "Order Permissions", | |
| "UpdateMyOrders": "Order Permissions", | |
| "UpdateOthersOrders": "Order Permissions", | |
| "CreateMyOrdersFromMyCarts": "Order Permissions", | |
| "CreateOrdersFromOthersCarts": "Order Permissions", | |
| "CreateMyOrdersFromMyQuotes": "Order Permissions", | |
| "CreateOrdersFromOthersQuotes": "Order Permissions", | |
| "ViewMyQuotes": "Quote Permissions", | |
| "ViewOthersQuotes": "Quote Permissions", | |
| "AcceptMyQuotes": "Quote Permissions", | |
| "AcceptOthersQuotes": "Quote Permissions", | |
| "DeclineMyQuotes": "Quote Permissions", | |
| "DeclineOthersQuotes": "Quote Permissions", | |
| "RenegotiateMyQuotes": "Quote Permissions", | |
| "RenegotiateOthersQuotes": "Quote Permissions", | |
| "ReassignMyQuotes": "Quote Permissions", | |
| "ReassignOthersQuotes": "Quote Permissions", | |
| "ViewMyQuoteRequests": "Quote Request Permissions", | |
| "ViewOthersQuoteRequests": "Quote Request Permissions", | |
| "UpdateMyQuoteRequests": "Quote Request Permissions", | |
| "UpdateOthersQuoteRequests": "Quote Request Permissions", | |
| "CreateMyQuoteRequestsFromMyCarts": "Quote Request Permissions", | |
| "CreateQuoteRequestsFromOthersCarts": "Quote Request Permissions", | |
| "CreateApprovalRules": "Approval Rule Permissions", | |
| "UpdateApprovalRules": "Approval Rule Permissions", | |
| "UpdateApprovalFlows": "Approval Flow Permissions", | |
| "ViewMyShoppingLists": "Shopping List Permissions", | |
| "ViewOthersShoppingLists": "Shopping List Permissions", | |
| "UpdateMyShoppingLists": "Shopping List Permissions", | |
| "UpdateOthersShoppingLists": "Shopping List Permissions", | |
| "CreateMyShoppingLists": "Shopping List Permissions", | |
| "CreateOthersShoppingLists": "Shopping List Permissions", | |
| "DeleteMyShoppingLists": "Shopping List Permissions", | |
| "DeleteOthersShoppingLists": "Shopping List Permissions" | |
| } | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/associate-roles/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/associate-roles/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/attribute-groups": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "attributes", | |
| "name" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "attributes": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "key" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/attribute-groups/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/attribute-groups/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/business-units": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "key", | |
| "name", | |
| "unitType" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "Active", | |
| "Inactive" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Active": "The Business Unit can be used in Carts, Orders, Quote Requests, and Quotes and can be edited.n", | |
| "Inactive": "The Business Unit cannot be used in Carts, Orders, Quote Requests, and Quotes and can only be edited using the [general endpoint](/../api/associates-overview#through-the-general-endpoints).n Status doesn't affect inheritance. Even if a parent unit is inactive, its children remain active and can inherit role assignments.n" | |
| } | |
| }, | |
| "stores": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "storeMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "FromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "Stores are defined on the Business Unit.n", | |
| "FromParent": "Stores are inherited from the closest parent in the hierarchy that has Stores defined.n" | |
| } | |
| }, | |
| "unitType": { | |
| "type": "string", | |
| "enum": [ | |
| "Company", | |
| "Division" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Company": "Top-level Business Unit. Must not have a `parentUnit` defined.n", | |
| "Division": "Business Unit with a `parentUnit` reference to a [Company](ctp:api:type:Division) or another Division.n" | |
| } | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "contactEmail": { | |
| "type": "string" | |
| }, | |
| "associateMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "ExplicitAndFromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "All Associates of a Business Unit must be explicitly assigned. The Business Unit cannot inherit Associates from a parent.n", | |
| "ExplicitAndFromParent": "Associates of a Business Unit can be assigned explicitly and inherited from a parent.n" | |
| } | |
| }, | |
| "associates": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRoleAssignments", | |
| "customer" | |
| ], | |
| "properties": { | |
| "associateRoleAssignments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRole" | |
| ], | |
| "properties": { | |
| "associateRole": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "inheritance": { | |
| "type": "string", | |
| "enum": [ | |
| "Enabled", | |
| "Disabled" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Enabled": "The assignment can be inherited by child Business Units.n", | |
| "Disabled": "The assignment cannot be inherited by child Business Units.n" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "Admin", | |
| "Buyer" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-deprecated": true, | |
| "x-annotation-enumDescriptions": { | |
| "Admin": "The Associate can update the Business Unit, create child Business Units and add or remove other Associates.n", | |
| "Buyer": "The Associate can make purchases on behalf of the Business Unit.n" | |
| } | |
| } | |
| }, | |
| "customer": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "approvalRuleMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "ExplicitAndFromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "Approval Rules of a Business Unit must be explicitly assigned. The Business Unit cannot inherit Approval Rules from a parent.n", | |
| "ExplicitAndFromParent": "Approval Rules of a Business Unit are inherited from a parent and can also be explicitly assigned.n" | |
| } | |
| }, | |
| "addresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "country" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "salutation": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "streetName": { | |
| "type": "string" | |
| }, | |
| "streetNumber": { | |
| "type": "string" | |
| }, | |
| "additionalStreetInfo": { | |
| "type": "string" | |
| }, | |
| "postalCode": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "company": { | |
| "type": "string" | |
| }, | |
| "department": { | |
| "type": "string" | |
| }, | |
| "building": { | |
| "type": "string" | |
| }, | |
| "apartment": { | |
| "type": "string" | |
| }, | |
| "pOBox": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "mobile": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "additionalAddressInfo": { | |
| "type": "string" | |
| }, | |
| "externalId": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "shippingAddresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "defaultShippingAddress": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "billingAddresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "defaultBillingAddress": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/business-units/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/business-units/key={key}/associates/{associateId}": { | |
| "get": {} | |
| }, | |
| "/{projectKey}/business-units/search": { | |
| "description": {}, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "properties": { | |
| "query": { | |
| "type": "object" | |
| }, | |
| "sort": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "field", | |
| "order" | |
| ], | |
| "properties": { | |
| "field": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "string", | |
| "enum": [ | |
| "asc", | |
| "desc" | |
| ], | |
| "x-annotation-package": "Search", | |
| "x-annotation-enumDescriptions": { | |
| "asc": "Ascending sort order, the lowest value is listed first.n", | |
| "desc": "Descending sort order, the highest value listed first.n" | |
| } | |
| }, | |
| "mode": { | |
| "type": "string", | |
| "enum": [ | |
| "min", | |
| "max", | |
| "avg", | |
| "sum" | |
| ], | |
| "x-annotation-package": "Search", | |
| "x-annotation-enumDescriptions": { | |
| "min": "Use the minimum of all available values.n", | |
| "max": "Use the maximum of all available values.n", | |
| "avg": "Use the average of all available values.n", | |
| "sum": "Use the sum of all available values.n" | |
| } | |
| }, | |
| "fieldType": { | |
| "type": "string", | |
| "enum": [ | |
| "boolean", | |
| "text", | |
| "ltext", | |
| "enum", | |
| "lenum", | |
| "number", | |
| "money", | |
| "date", | |
| "datetime", | |
| "time", | |
| "reference", | |
| "set_boolean", | |
| "set_text", | |
| "set_ltext", | |
| "set_enum", | |
| "set_lenum", | |
| "set_number", | |
| "set_money", | |
| "set_date", | |
| "set_datetime", | |
| "set_time", | |
| "set_reference" | |
| ], | |
| "x-annotation-package": "Search", | |
| "x-annotation-enumDescriptions": { | |
| "boolean": "For Boolean fields, [AttributeBooleanType](ctp:api:type:AttributeBooleanType) Attributes, and [BooleanType](ctp:api:type:CustomFieldBooleanType) Custom Fields.n", | |
| "text": "For string fields, [AttributeTextType](ctp:api:type:AttributeTextType) Attributes, and [StringType](ctp:api:type:CustomFieldStringType) Custom Fields.n", | |
| "ltext": "For [LocalizedString](types#localizedstring) fields, [AttributeLocalizableTextType](ctp:api:type:AttributeLocalizableTextType) Attributes,nand [LocalizedStringType](ctp:api:type:CustomFieldLocalizedStringType) Custom Fields.n", | |
| "enum": "For enum fields, [AttributeEnumType](ctp:api:type:AttributeEnumType) Attributes, and [EnumType](ctp:api:type:CustomFieldEnumType) Custom Fields.n", | |
| "lenum": "For localized enum fields, [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) Attributes, and [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) Custom Fields.n", | |
| "number": "For number fields, [AttributeNumberType](ctp:api:type:AttributeNumberType) Attributes, and [NumberType](ctp:api:type:CustomFieldNumberType) Custom Fields.n", | |
| "money": "For [Money](types#money) fields and [AttributeMoneyType](ctp:api:type:AttributeMoneyType) Attributes.n", | |
| "date": "For [Date](types#date) fields, [AttributeDateType](ctp:api:type:AttributeDateType) Attributes, and [DateType](ctp:api:type:CustomFieldDateType) Custom Fields.n", | |
| "datetime": "For [DateTime](types#datetime) fields, [AttributeDateTimeType](ctp:api:type:AttributeDateTimeType) Attributes, and [DateTimeType](ctp:api:type:CustomFieldDateTimeType) Custom Fields.n", | |
| "time": "For [Time](types#time) fields, [AttributeTimeType](ctp:api:type:AttributeTimeType) Attributes, and [TimeType](ctp:api:type:CustomFieldTimeType) Custom Fields.n", | |
| "reference": "For [Reference](types#reference) fields and [AttributeReferenceType](ctp:api:type:AttributeReferenceType) Attributes.n", | |
| "set_boolean": "For Set of Boolean fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `boolean` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `boolean` Custom Fields.n", | |
| "set_text": "For Set of string fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `text` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `text` Custom Fields.n", | |
| "set_ltext": "For Set of [LocalizedString](types#localizedstring) fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `ltext` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `ltext` Custom Fields.n", | |
| "set_enum": "For Set of enum fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `enum` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `enum` Custom Fields.n", | |
| "set_lenum": "For Set of localized enum fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `lenum` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `lenum` Custom Fields.n", | |
| "set_number": "For Set of number fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `number` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `number` Custom Fields.n", | |
| "set_money": "For Set of [Money](types#money) fields and [AttributeSetType](ctp:api:type:AttributeSetType) of `money` Attributes.n", | |
| "set_date": "For Set of [Date](types#date) fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `date` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `date` Custom Fields.n", | |
| "set_datetime": "For Set of [DateTime](types#datetime) fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `datetime` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `datetime` Custom Fields.n", | |
| "set_time": "For Set of [Time](types#time) fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `time` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `time` Custom Fields.n", | |
| "set_reference": "For Set of [Reference](types#reference) fields and [AttributeSetType](ctp:api:type:AttributeSetType) of `reference` Attributes.n" | |
| } | |
| }, | |
| "filter": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "limit": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "offset": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "limit", | |
| "offset", | |
| "results", | |
| "total" | |
| ], | |
| "properties": { | |
| "total": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "limit": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "offset": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "relevance" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "relevance": { | |
| "type": "number", | |
| "format": "double", | |
| "minimum": -1.7976931348623157e+308, | |
| "maximum": 1.7976931348623157e+308 | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "409": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/business-units/search/indexing-status": { | |
| "get": { | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "status" | |
| ], | |
| "properties": { | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "Scheduled", | |
| "Indexing", | |
| "Ready", | |
| "Failed" | |
| ], | |
| "x-annotation-package": "Project", | |
| "x-annotation-enumDescriptions": { | |
| "Scheduled": "Indexing is scheduled.", | |
| "Indexing": "Indexing is in progress.", | |
| "Ready": "Indexing is complete and the [Search Business Units](ctp:api:endpoint:/{projectKey}/business-units/search:POST) endpoint returns up-to-date results.", | |
| "Failed": "Indexing failed due to an internal error." | |
| } | |
| }, | |
| "states": { | |
| "type": "object", | |
| "required": [ | |
| "estimatedTotal", | |
| "failed", | |
| "indexed" | |
| ], | |
| "properties": { | |
| "indexed": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "failed": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "estimatedTotal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| } | |
| }, | |
| "startedAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "lastModifiedAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "retryCount": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/business-units/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/business-units/{businessUnitId}/associates/{associateId}": { | |
| "get": {} | |
| }, | |
| "/{projectKey}/cart-discounts": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "cartPredicate", | |
| "name", | |
| "sortOrder", | |
| "value" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "value": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "cartPredicate": { | |
| "type": "string" | |
| }, | |
| "target": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "sortOrder": { | |
| "type": "string" | |
| }, | |
| "stores": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "isActive": { | |
| "type": "boolean" | |
| }, | |
| "validFrom": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "validUntil": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "requiresDiscountCode": { | |
| "type": "boolean" | |
| }, | |
| "stackingMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Stacking", | |
| "StopAfterThisDiscount" | |
| ], | |
| "x-annotation-package": "CartDiscount", | |
| "x-annotation-enumDescriptions": { | |
| "Stacking": "Applies other matching Discounts after applying this one.", | |
| "StopAfterThisDiscount": "Doesn't apply any more matching Discounts after this one if it's successfully applied." | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/cart-discounts/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/cart-discounts/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/carts": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": {} | |
| }, | |
| "/{projectKey}/carts/customer-id={customerId}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/carts/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/carts/replicate": { | |
| "post": {} | |
| }, | |
| "/{projectKey}/carts/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/categories": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "slug": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "parent": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "orderHint": { | |
| "type": "string" | |
| }, | |
| "externalId": { | |
| "type": "string" | |
| }, | |
| "metaTitle": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "metaDescription": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "metaKeywords": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "assets": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "sources" | |
| ], | |
| "properties": { | |
| "sources": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "uri" | |
| ], | |
| "properties": { | |
| "uri": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "dimensions": { | |
| "type": "object", | |
| "required": [ | |
| "h", | |
| "w" | |
| ], | |
| "properties": { | |
| "w": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "h": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| } | |
| }, | |
| "contentType": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/categories/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/categories/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/channels": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "key" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "InventorySupply", | |
| "ProductDistribution", | |
| "OrderExport", | |
| "OrderImport", | |
| "Primary" | |
| ], | |
| "x-annotation-package": "Channel", | |
| "x-annotation-enumDescriptions": { | |
| "InventorySupply": "Channel can be used to track inventory entries (for example, Channels with this role can be treated as warehouses).n", | |
| "ProductDistribution": "Channel can be used to expose Products to a specific distribution Channel.nThe Channel can be used by a Cart to [select](/../api/pricing-and-discounts-overview#line-item-price-selection) a Product Price.n", | |
| "OrderExport": "Channel can be used to track order export activities.n", | |
| "OrderImport": "Channel can be used to track order import activities.n", | |
| "Primary": "This role can be combined with the other roles (for example, with `InventorySupply`). If used, the Channel is considered as the primary or main channel among Channels of the same type.n" | |
| } | |
| } | |
| }, | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "address": { | |
| "type": "object", | |
| "required": [ | |
| "country" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "salutation": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "streetName": { | |
| "type": "string" | |
| }, | |
| "streetNumber": { | |
| "type": "string" | |
| }, | |
| "additionalStreetInfo": { | |
| "type": "string" | |
| }, | |
| "postalCode": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "company": { | |
| "type": "string" | |
| }, | |
| "department": { | |
| "type": "string" | |
| }, | |
| "building": { | |
| "type": "string" | |
| }, | |
| "apartment": { | |
| "type": "string" | |
| }, | |
| "pOBox": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "mobile": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "additionalAddressInfo": { | |
| "type": "string" | |
| }, | |
| "externalId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "geoLocation": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/channels/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/channels/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/custom-objects": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "container", | |
| "key", | |
| "value" | |
| ], | |
| "properties": { | |
| "container": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "value": {}, | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/custom-objects/{container}": { | |
| "get": {} | |
| }, | |
| "/{projectKey}/custom-objects/{container}/{key}": { | |
| "get": {}, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/customer-groups": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "groupName" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "groupName": { | |
| "type": "string" | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customer-groups/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/customer-groups/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/customers": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "email" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "customerNumber": { | |
| "type": "string" | |
| }, | |
| "externalId": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "middleName": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "anonymousCartId": { | |
| "type": "string" | |
| }, | |
| "anonymousCart": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "anonymousId": { | |
| "type": "string" | |
| }, | |
| "dateOfBirth": { | |
| "type": "string", | |
| "format": "date-only" | |
| }, | |
| "companyName": { | |
| "type": "string" | |
| }, | |
| "vatId": { | |
| "type": "string" | |
| }, | |
| "addresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "country" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "salutation": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "streetName": { | |
| "type": "string" | |
| }, | |
| "streetNumber": { | |
| "type": "string" | |
| }, | |
| "additionalStreetInfo": { | |
| "type": "string" | |
| }, | |
| "postalCode": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "company": { | |
| "type": "string" | |
| }, | |
| "department": { | |
| "type": "string" | |
| }, | |
| "building": { | |
| "type": "string" | |
| }, | |
| "apartment": { | |
| "type": "string" | |
| }, | |
| "pOBox": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "mobile": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "additionalAddressInfo": { | |
| "type": "string" | |
| }, | |
| "externalId": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "defaultShippingAddress": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "shippingAddresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "defaultBillingAddress": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "billingAddresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "isEmailVerified": { | |
| "type": "boolean" | |
| }, | |
| "customerGroup": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "salutation": { | |
| "type": "string" | |
| }, | |
| "stores": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "authenticationMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Password", | |
| "ExternalAuth" | |
| ], | |
| "x-annotation-package": "Customer", | |
| "x-annotation-enumDescriptions": { | |
| "Password": "This is the default value. If set, the `password` field is required on [CustomerDraft](ctp:api:type:CustomerDraft) and is present on [Customer](ctp:api:type:Customer).", | |
| "ExternalAuth": "If set, the `password` field is optional on [CustomerDraft](ctp:api:type:CustomerDraft) and is not present on [Customer](ctp:api:type:Customer)." | |
| } | |
| }, | |
| "customerGroupAssignments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "customerGroup" | |
| ], | |
| "properties": { | |
| "customerGroup": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customers/email-token": { | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "ttlMinutes" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "ttlMinutes": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "invalidateOlderTokens": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "createdAt", | |
| "customerId", | |
| "expiresAt", | |
| "id", | |
| "invalidateOlderTokens", | |
| "value" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "customerId": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "expiresAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "invalidateOlderTokens": { | |
| "type": "boolean" | |
| }, | |
| "createdAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "lastModifiedAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customers/email-token={emailToken}": { | |
| "get": {} | |
| }, | |
| "/{projectKey}/customers/email/confirm": { | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "tokenValue" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "tokenValue": { | |
| "type": "string" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customers/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/customers/password": { | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "currentPassword", | |
| "id", | |
| "newPassword", | |
| "version" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "currentPassword": { | |
| "type": "string" | |
| }, | |
| "newPassword": { | |
| "type": "string" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customers/password-token": { | |
| "description": {}, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "email" | |
| ], | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "ttlMinutes": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "invalidateOlderTokens": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "createdAt", | |
| "customerId", | |
| "expiresAt", | |
| "id", | |
| "invalidateOlderTokens", | |
| "value" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "customerId": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "expiresAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "invalidateOlderTokens": { | |
| "type": "boolean" | |
| }, | |
| "createdAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "lastModifiedAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customers/password-token={passwordToken}": { | |
| "get": {} | |
| }, | |
| "/{projectKey}/customers/password/reset": { | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "newPassword", | |
| "tokenValue" | |
| ], | |
| "properties": { | |
| "tokenValue": { | |
| "type": "string" | |
| }, | |
| "newPassword": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customers/search": { | |
| "description": {}, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "properties": { | |
| "query": { | |
| "type": "object" | |
| }, | |
| "sort": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "field", | |
| "order" | |
| ], | |
| "properties": { | |
| "field": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "string", | |
| "enum": [ | |
| "asc", | |
| "desc" | |
| ], | |
| "x-annotation-package": "Search", | |
| "x-annotation-enumDescriptions": { | |
| "asc": "Ascending sort order, the lowest value is listed first.n", | |
| "desc": "Descending sort order, the highest value listed first.n" | |
| } | |
| }, | |
| "mode": { | |
| "type": "string", | |
| "enum": [ | |
| "min", | |
| "max", | |
| "avg", | |
| "sum" | |
| ], | |
| "x-annotation-package": "Search", | |
| "x-annotation-enumDescriptions": { | |
| "min": "Use the minimum of all available values.n", | |
| "max": "Use the maximum of all available values.n", | |
| "avg": "Use the average of all available values.n", | |
| "sum": "Use the sum of all available values.n" | |
| } | |
| }, | |
| "fieldType": { | |
| "type": "string", | |
| "enum": [ | |
| "boolean", | |
| "text", | |
| "ltext", | |
| "enum", | |
| "lenum", | |
| "number", | |
| "money", | |
| "date", | |
| "datetime", | |
| "time", | |
| "reference", | |
| "set_boolean", | |
| "set_text", | |
| "set_ltext", | |
| "set_enum", | |
| "set_lenum", | |
| "set_number", | |
| "set_money", | |
| "set_date", | |
| "set_datetime", | |
| "set_time", | |
| "set_reference" | |
| ], | |
| "x-annotation-package": "Search", | |
| "x-annotation-enumDescriptions": { | |
| "boolean": "For Boolean fields, [AttributeBooleanType](ctp:api:type:AttributeBooleanType) Attributes, and [BooleanType](ctp:api:type:CustomFieldBooleanType) Custom Fields.n", | |
| "text": "For string fields, [AttributeTextType](ctp:api:type:AttributeTextType) Attributes, and [StringType](ctp:api:type:CustomFieldStringType) Custom Fields.n", | |
| "ltext": "For [LocalizedString](types#localizedstring) fields, [AttributeLocalizableTextType](ctp:api:type:AttributeLocalizableTextType) Attributes,nand [LocalizedStringType](ctp:api:type:CustomFieldLocalizedStringType) Custom Fields.n", | |
| "enum": "For enum fields, [AttributeEnumType](ctp:api:type:AttributeEnumType) Attributes, and [EnumType](ctp:api:type:CustomFieldEnumType) Custom Fields.n", | |
| "lenum": "For localized enum fields, [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) Attributes, and [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) Custom Fields.n", | |
| "number": "For number fields, [AttributeNumberType](ctp:api:type:AttributeNumberType) Attributes, and [NumberType](ctp:api:type:CustomFieldNumberType) Custom Fields.n", | |
| "money": "For [Money](types#money) fields and [AttributeMoneyType](ctp:api:type:AttributeMoneyType) Attributes.n", | |
| "date": "For [Date](types#date) fields, [AttributeDateType](ctp:api:type:AttributeDateType) Attributes, and [DateType](ctp:api:type:CustomFieldDateType) Custom Fields.n", | |
| "datetime": "For [DateTime](types#datetime) fields, [AttributeDateTimeType](ctp:api:type:AttributeDateTimeType) Attributes, and [DateTimeType](ctp:api:type:CustomFieldDateTimeType) Custom Fields.n", | |
| "time": "For [Time](types#time) fields, [AttributeTimeType](ctp:api:type:AttributeTimeType) Attributes, and [TimeType](ctp:api:type:CustomFieldTimeType) Custom Fields.n", | |
| "reference": "For [Reference](types#reference) fields and [AttributeReferenceType](ctp:api:type:AttributeReferenceType) Attributes.n", | |
| "set_boolean": "For Set of Boolean fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `boolean` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `boolean` Custom Fields.n", | |
| "set_text": "For Set of string fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `text` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `text` Custom Fields.n", | |
| "set_ltext": "For Set of [LocalizedString](types#localizedstring) fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `ltext` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `ltext` Custom Fields.n", | |
| "set_enum": "For Set of enum fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `enum` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `enum` Custom Fields.n", | |
| "set_lenum": "For Set of localized enum fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `lenum` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `lenum` Custom Fields.n", | |
| "set_number": "For Set of number fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `number` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `number` Custom Fields.n", | |
| "set_money": "For Set of [Money](types#money) fields and [AttributeSetType](ctp:api:type:AttributeSetType) of `money` Attributes.n", | |
| "set_date": "For Set of [Date](types#date) fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `date` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `date` Custom Fields.n", | |
| "set_datetime": "For Set of [DateTime](types#datetime) fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `datetime` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `datetime` Custom Fields.n", | |
| "set_time": "For Set of [Time](types#time) fields, [AttributeSetType](ctp:api:type:AttributeSetType) of `time` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `time` Custom Fields.n", | |
| "set_reference": "For Set of [Reference](types#reference) fields and [AttributeSetType](ctp:api:type:AttributeSetType) of `reference` Attributes.n" | |
| } | |
| }, | |
| "filter": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "limit": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "offset": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "limit", | |
| "offset", | |
| "results", | |
| "total" | |
| ], | |
| "properties": { | |
| "total": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "limit": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "offset": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "relevance" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "relevance": { | |
| "type": "number", | |
| "format": "double", | |
| "minimum": -1.7976931348623157e+308, | |
| "maximum": 1.7976931348623157e+308 | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "409": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customers/search/indexing-status": { | |
| "get": { | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "required": [ | |
| "status" | |
| ], | |
| "properties": { | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "Scheduled", | |
| "Indexing", | |
| "Ready", | |
| "Failed" | |
| ], | |
| "x-annotation-package": "Project", | |
| "x-annotation-enumDescriptions": { | |
| "Scheduled": "Indexing is scheduled.", | |
| "Indexing": "Indexing is in progress.", | |
| "Ready": "Indexing is complete and the [Search Customers](ctp:api:endpoint:/{projectKey}/customers/search:POST) endpoint returns up-to-date results.", | |
| "Failed": "Indexing failed due to an internal error." | |
| } | |
| }, | |
| "states": { | |
| "type": "object", | |
| "required": [ | |
| "estimatedTotal", | |
| "failed", | |
| "indexed" | |
| ], | |
| "properties": { | |
| "indexed": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "failed": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "estimatedTotal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| } | |
| }, | |
| "startedAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "lastModifiedAt": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "retryCount": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/customers/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/discount-codes": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "cartDiscounts", | |
| "code" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "code": { | |
| "type": "string" | |
| }, | |
| "cartDiscounts": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "cartPredicate": { | |
| "type": "string" | |
| }, | |
| "isActive": { | |
| "type": "boolean" | |
| }, | |
| "maxApplications": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "maxApplicationsPerCustomer": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "groups": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "validFrom": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "validUntil": { | |
| "type": "string", | |
| "format": "datetime" | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/discount-codes/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/discount-codes/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/extensions": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "destination", | |
| "triggers" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "triggers": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "resourceTypeId" | |
| ], | |
| "properties": { | |
| "resourceTypeId": { | |
| "type": "string", | |
| "enum": [ | |
| "cart", | |
| "order", | |
| "payment", | |
| "customer", | |
| "customer-group", | |
| "quote-request", | |
| "staged-quote", | |
| "quote", | |
| "business-unit", | |
| "shopping-list" | |
| ], | |
| "x-annotation-package": "Extension", | |
| "x-annotation-enumDescriptions": { | |
| "cart": "Extension triggered for operations on [Carts](/../api/projects/carts).", | |
| "order": "Extension triggered for operations on [Orders](/../api/projects/orders).", | |
| "payment": "Extension triggered for operations on [Payments](/../api/projects/payments).", | |
| "customer": "Extension triggered for operations on [Customers](/../api/projects/customers).", | |
| "customer-group": "Extension triggered for operations on [CustomerGroups](/../api/projects/customerGroups).", | |
| "quote-request": "Extension triggered for operations on [QuoteRequests](/../api/projects/quote-requests).", | |
| "staged-quote": "Extension triggered for operations on [StagedQuotes](/../api/projects/staged-quotes).", | |
| "quote": "Extension triggered for operations on [Quotes](/../api/projects/quotes).", | |
| "business-unit": "Extension triggered for operations on [BusinessUnits](/../api/projects/business-units).", | |
| "shopping-list": "Extension triggered for operations on [ShoppingLists](/../api/projects/shoppingLists)." | |
| } | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "Create", | |
| "Update" | |
| ], | |
| "x-annotation-package": "Extension", | |
| "x-annotation-enumDescriptions": { | |
| "Create": "An Extension gets called during a Create request.", | |
| "Update": "An Extension gets called during an Update request." | |
| } | |
| } | |
| }, | |
| "condition": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "timeoutInMs": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/extensions/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/extensions/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/graphql": { | |
| "description": {}, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "query" | |
| ], | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "operationName": { | |
| "type": "string" | |
| }, | |
| "variables": { | |
| "type": "object", | |
| "required": [ | |
| "//" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "responses": { | |
| "200": { | |
| "type": "object", | |
| "properties": { | |
| "data": {}, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "extensions", | |
| "locations", | |
| "message" | |
| ], | |
| "properties": { | |
| "message": { | |
| "type": "string" | |
| }, | |
| "locations": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "column", | |
| "line" | |
| ], | |
| "properties": { | |
| "line": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "column": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| } | |
| } | |
| } | |
| }, | |
| "path": { | |
| "type": "array" | |
| }, | |
| "extensions": { | |
| "type": "object", | |
| "required": [ | |
| "code" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| } | |
| }, | |
| "/{projectKey}/in-business-unit/key={businessUnitKey}/me/customers": { | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "associateRoleAssignments", | |
| "customer", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "customer": { | |
| "type": "object", | |
| "required": [ | |
| "email", | |
| "password" | |
| ], | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "middleName": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "salutation": { | |
| "type": "string" | |
| }, | |
| "dateOfBirth": { | |
| "type": "string", | |
| "format": "date-only" | |
| }, | |
| "companyName": { | |
| "type": "string" | |
| }, | |
| "vatId": { | |
| "type": "string" | |
| }, | |
| "addresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "country" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "salutation": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "streetName": { | |
| "type": "string" | |
| }, | |
| "streetNumber": { | |
| "type": "string" | |
| }, | |
| "additionalStreetInfo": { | |
| "type": "string" | |
| }, | |
| "postalCode": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "company": { | |
| "type": "string" | |
| }, | |
| "department": { | |
| "type": "string" | |
| }, | |
| "building": { | |
| "type": "string" | |
| }, | |
| "apartment": { | |
| "type": "string" | |
| }, | |
| "pOBox": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "mobile": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "additionalAddressInfo": { | |
| "type": "string" | |
| }, | |
| "externalId": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "defaultShippingAddress": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "defaultBillingAddress": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "stores": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "associateRoleAssignments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRole" | |
| ], | |
| "properties": { | |
| "associateRole": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "inheritance": { | |
| "type": "string", | |
| "enum": [ | |
| "Enabled", | |
| "Disabled" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Enabled": "The assignment can be inherited by child Business Units.n", | |
| "Disabled": "The assignment cannot be inherited by child Business Units.n" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/in-store/key={storeKey}/business-units": { | |
| "description": {}, | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "key", | |
| "name", | |
| "unitType" | |
| ], | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "Active", | |
| "Inactive" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Active": "The Business Unit can be used in Carts, Orders, Quote Requests, and Quotes and can be edited.n", | |
| "Inactive": "The Business Unit cannot be used in Carts, Orders, Quote Requests, and Quotes and can only be edited using the [general endpoint](/../api/associates-overview#through-the-general-endpoints).n Status doesn't affect inheritance. Even if a parent unit is inactive, its children remain active and can inherit role assignments.n" | |
| } | |
| }, | |
| "stores": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "storeMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "FromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "Stores are defined on the Business Unit.n", | |
| "FromParent": "Stores are inherited from the closest parent in the hierarchy that has Stores defined.n" | |
| } | |
| }, | |
| "unitType": { | |
| "type": "string", | |
| "enum": [ | |
| "Company", | |
| "Division" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Company": "Top-level Business Unit. Must not have a `parentUnit` defined.n", | |
| "Division": "Business Unit with a `parentUnit` reference to a [Company](ctp:api:type:Division) or another Division.n" | |
| } | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "contactEmail": { | |
| "type": "string" | |
| }, | |
| "associateMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "ExplicitAndFromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "All Associates of a Business Unit must be explicitly assigned. The Business Unit cannot inherit Associates from a parent.n", | |
| "ExplicitAndFromParent": "Associates of a Business Unit can be assigned explicitly and inherited from a parent.n" | |
| } | |
| }, | |
| "associates": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRoleAssignments", | |
| "customer" | |
| ], | |
| "properties": { | |
| "associateRoleAssignments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "associateRole" | |
| ], | |
| "properties": { | |
| "associateRole": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "inheritance": { | |
| "type": "string", | |
| "enum": [ | |
| "Enabled", | |
| "Disabled" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Enabled": "The assignment can be inherited by child Business Units.n", | |
| "Disabled": "The assignment cannot be inherited by child Business Units.n" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "Admin", | |
| "Buyer" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-deprecated": true, | |
| "x-annotation-enumDescriptions": { | |
| "Admin": "The Associate can update the Business Unit, create child Business Units and add or remove other Associates.n", | |
| "Buyer": "The Associate can make purchases on behalf of the Business Unit.n" | |
| } | |
| } | |
| }, | |
| "customer": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "approvalRuleMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Explicit", | |
| "ExplicitAndFromParent" | |
| ], | |
| "x-annotation-package": "BusinessUnit", | |
| "x-annotation-enumDescriptions": { | |
| "Explicit": "Approval Rules of a Business Unit must be explicitly assigned. The Business Unit cannot inherit Approval Rules from a parent.n", | |
| "ExplicitAndFromParent": "Approval Rules of a Business Unit are inherited from a parent and can also be explicitly assigned.n" | |
| } | |
| }, | |
| "addresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "country" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "salutation": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "streetName": { | |
| "type": "string" | |
| }, | |
| "streetNumber": { | |
| "type": "string" | |
| }, | |
| "additionalStreetInfo": { | |
| "type": "string" | |
| }, | |
| "postalCode": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "company": { | |
| "type": "string" | |
| }, | |
| "department": { | |
| "type": "string" | |
| }, | |
| "building": { | |
| "type": "string" | |
| }, | |
| "apartment": { | |
| "type": "string" | |
| }, | |
| "pOBox": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "mobile": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "additionalAddressInfo": { | |
| "type": "string" | |
| }, | |
| "externalId": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "shippingAddresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "defaultShippingAddress": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "billingAddresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| } | |
| }, | |
| "defaultBillingAddress": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-zA-Z0-9_-]{2,36}$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "/{projectKey}/in-store/key={storeKey}/business-units/key={key}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/in-store/key={storeKey}/business-units/key={key}/associates/{associateId}": { | |
| "get": {} | |
| }, | |
| "/{projectKey}/in-store/key={storeKey}/business-units/{ID}": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "actions", | |
| "version" | |
| ], | |
| "properties": { | |
| "version": { | |
| "type": "integer", | |
| "format": "int64", | |
| "minimum": -9223372036854776000, | |
| "maximum": 9223372036854776000 | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "action" | |
| ], | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| }, | |
| "delete": {} | |
| }, | |
| "/{projectKey}/in-store/key={storeKey}/business-units/{businessUnitId}/associates/{associateId}": { | |
| "get": {} | |
| }, | |
| "/{projectKey}/in-store/key={storeKey}/cart-discounts": { | |
| "get": {}, | |
| "head": { | |
| "responses": { | |
| "200": {}, | |
| "400": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "401": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "403": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "404": {}, | |
| "500": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "502": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| }, | |
| "503": { | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "statusCode" | |
| ], | |
| "properties": { | |
| "statusCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": -2147483648, | |
| "maximum": 2147483647 | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "$schema": "http://json-schema.org/draft-04/schema#" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "body": { | |
| "type": "object", | |
| "required": [ | |
| "cartPredicate", | |
| "name", | |
| "sortOrder", | |
| "value" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "object", | |
| "required": [ | |
| "/^[a-z]{2}(-[A-Z]{2})?$/" | |
| ], | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| }, | |
| "value": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "cartPredicate": { | |
| "type": "string" | |
| }, | |
| "target": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "sortOrder": { | |
| "type": "string" | |
| }, | |
| "stores": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "References a [Product](ctp:api:type:Product).n", | |
| "product-discount": "References a [ProductDiscount](ctp:api:type:ProductDiscount).n", | |
| "product-price": "References an [Embedded Price](ctp:api:type:Price).n", | |
| "product-selection": "References a [ProductSelection](ctp:api:type:ProductSelection).n", | |
| "product-tailoring": "References a [ProductTailoring](ctp:api:type:ProductTailoring).n", | |
| "product-type": "References a [ProductType](ctp:api:type:ProductType).n", | |
| "quote": "References a [Quote](ctp:api:type:Quote).n", | |
| "quote-request": "References a [QuoteRequest](ctp:api:type:QuoteRequest).n", | |
| "review": "References a [Review](ctp:api:type:Review).n", | |
| "shipping-method": "References a [ShippingMethod](ctp:api:type:ShippingMethod).n", | |
| "shopping-list": "References a [ShoppingList](ctp:api:type:ShoppingList).n", | |
| "staged-quote": "References a [StagedQuote](ctp:api:type:StagedQuote).n", | |
| "standalone-price": "References a [StandalonePrice](ctp:api:type:StandalonePrice).n", | |
| "state": "References a [State](ctp:api:type:State).n", | |
| "store": "References a [Store](ctp:api:type:Store).n", | |
| "subscription": "References a [Subscription](ctp:api:type:Subscription).n", | |
| "tax-category": "References a [TaxCategory](ctp:api:type:TaxCategory).n", | |
| "type": "References a [Type](ctp:api:type:Type).n", | |
| "zone": "References a [Zone](ctp:api:type:Zone).n" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "isActive": { | |
| "type": "boolean" | |
| }, | |
| "validFrom": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "validUntil": { | |
| "type": "string", | |
| "format": "datetime" | |
| }, | |
| "requiresDiscountCode": { | |
| "type": "boolean" | |
| }, | |
| "stackingMode": { | |
| "type": "string", | |
| "enum": [ | |
| "Stacking", | |
| "StopAfterThisDiscount" | |
| ], | |
| "x-annotation-package": "CartDiscount", | |
| "x-annotation-enumDescriptions": { | |
| "Stacking": "Applies other matching Discounts after applying this one.", | |
| "StopAfterThisDiscount": "Doesn't apply any more matching Discounts after this one if it's successfully applied." | |
| } | |
| }, | |
| "custom": { | |
| "type": "object", | |
| "required": [ | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "object", | |
| "required": [ | |
| "typeId" | |
| ], | |
| "properties": { | |
| "typeId": { | |
| "type": "string", | |
| "enum": [ | |
| "approval-flow", | |
| "approval-rule", | |
| "associate-role", | |
| "attribute-group", | |
| "business-unit", | |
| "cart", | |
| "cart-discount", | |
| "category", | |
| "channel", | |
| "customer", | |
| "customer-email-token", | |
| "customer-group", | |
| "customer-password-token", | |
| "direct-discount", | |
| "discount-code", | |
| "extension", | |
| "inventory-entry", | |
| "key-value-document", | |
| "order", | |
| "order-edit", | |
| "payment", | |
| "product", | |
| "product-discount", | |
| "product-price", | |
| "product-selection", | |
| "product-tailoring", | |
| "product-type", | |
| "quote", | |
| "quote-request", | |
| "review", | |
| "shipping-method", | |
| "shopping-list", | |
| "staged-quote", | |
| "standalone-price", | |
| "state", | |
| "store", | |
| "subscription", | |
| "tax-category", | |
| "type", | |
| "zone" | |
| ], | |
| "x-annotation-package": "Common", | |
| "x-annotation-enumDescriptions": { | |
| "approval-flow": "References an [ApprovalFlow](ctp:api:type:ApprovalFlow). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "approval-rule": "References an [ApprovalRule](ctp:api:type:ApprovalRule). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "associate-role": "References an [AssociateRole](ctp:api:type:AssociateRole). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "attribute-group": "References an [AttributeGroup](ctp:api:type:AttributeGroup).n", | |
| "business-unit": "References a [BusinessUnit](ctp:api:type:BusinessUnit). Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.n", | |
| "cart": "References a [Cart](ctp:api:type:Cart).n", | |
| "cart-discount": "References a [CartDiscount](ctp:api:type:CartDiscount).n", | |
| "category": "References a [Category](ctp:api:type:Category).n", | |
| "channel": "References a [Channel](ctp:api:type:Channel).n", | |
| "customer": "References a [Customer](ctp:api:type:Customer).n", | |
| "customer-email-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).n", | |
| "customer-group": "References a [CustomerGroup](ctp:api:type:CustomerGroup).n", | |
| "customer-password-token": "References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).n", | |
| "direct-discount": "References a [DirectDiscount](ctp:api:type:DirectDiscount).n", | |
| "discount-code": "References a [DiscountCode](ctp:api:type:DiscountCode).n", | |
| "extension": "References an [Extension](ctp:api:type:Extension).n", | |
| "inventory-entry": "References an [InventoryEntry](ctp:api:type:InventoryEntry).n", | |
| "key-value-document": "References a [CustomObject](ctp:api:type:CustomObject).n", | |
| "order": "References an [Order](ctp:api:type:Order).n", | |
| "order-edit": "References an [Order Edit](ctp:api:type:OrderEdit).n", | |
| "payment": "References a [Payment](ctp:api:type:Payment).n", | |
| "product": "R |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment