Download OpenAPI specification:Download
This API uses JWT for authorization. SPARETECH will provide your client credentials, that are specific to each organisation and integration environment. See the Authentication section of this documentation for details on how to obtain a token.
Security scheme type: | HTTP |
---|---|
HTTP Authorization Scheme | bearer |
Bearer format | "JWT" |
Retrieves a JWT bearer token to authorize requests. The token has an expiration time and can be requested a limited number of times per day.
Client ID and Client Secret pair.
clientId required | string |
clientSecret required | string |
A dictionary with a JWT, its time until expiration, and type.
You have exceeded your token quota and cannot create any more tokens until {timestamp}
Production environment
Sandbox environment
Returns a list of attributes that can occur in the metadata object. Corresponds to the export mapping of your organisation.
A list of strings
containing attributes that can occur in the metadata object.
Production environment
Sandbox environment
Returns a list of attributes that can occur in the request body of the Import Material endpoint. Corresponds to the Material Master fields of your organisation.
A list of strings
containing all the names of the attributes that can occur in the request body of the Import Material endpoint.
Production environment
Sandbox environment
Returns a list of CreationIntents.
status | string (CreationIntentStatus) Enum: "Ready" "Done" Example: status=Ready Only returns intents in the given status. Allowed statuses are |
created.gt | string <date> Example: created.gt=2022-12-10 A filter based on the object's |
created.lt | string <date> Example: created.lt=2022-12-13 A filter based on the object's |
limit | integer Default: 10 A limit on the number of objects to be returned. Limit can range between 1 and 99, and the default is 10. |
page | integer Default: 0 A cursor for pagination across multiple pages of results. |
A dictionary with a creationIntents
property that contains an array of up to limit
. CreationIntents.
Creation intent {id} couldn't be found
Production environment
Sandbox environment
Retrieves the details of a CreationIntent that has previously been created.
id required | string |
A CreationIntent
if a valid id
was provided.
Creation intent {id} couldn't be found
Production environment
Sandbox environment
Confirms the material creation by supplying the material number.
id required | string |
materialNumber required | string |
The updated CreationIntent
after adding the material number.
Creation intent {id} couldn't be found
Production environment
Sandbox environment
Marks the intent as rejected by the external system.
id required | string |
message required | string Short description of the reason for rejecting the intent. |
OK
Creation intent {id} couldn't be found
Production environment
Sandbox environment
Returns a list of ChangeIntents.
status | string (ChangeIntentStatus) Enum: "Ready" "Done" Example: status=Done Only returns intents in the given status. |
created.gt | string <date> Example: created.gt=2022-12-10 A filter based on the object's |
created.lt | string <date> Example: created.lt=2022-12-13 A filter based on the object's |
limit | integer Default: 10 A limit on the number of objects to be returned. Limit can range between 1 and 99, and the default is 10. |
page | integer Default: 0 A cursor for pagination across multiple pages of results. |
changes.only | boolean Default: true If true, this endpoint only returns fields that have changes as part of the |
A dictionary with a changeIntents
property that contains an array of up to limit
ChangeIntents.
Change intent {id} couldn't be found
Production environment
Sandbox environment
Retrieves the details of a ChangeIntent that has previously been created.
id required | string |
changes.only | boolean Default: true If true, this endpoint only returns fields that have changes as part of the |
A ChangeIntent
if a valid id
was provided.
Change intent {id} couldn't be found
Production environment
Sandbox environment
Confirms the change to the material.
id required | string |
OK
Change intent {id} couldn't be found
Production environment
Sandbox environment
Marks the intent as rejected by the external system.
id required | string |
message required | string Short description of the reason for rejecting the intent. |
OK
Change intent {id} couldn't be found
Production environment
Sandbox environment
Returns a list of ExtensionIntents.
status | string (ExtensionIntentStatus) Enum: "Ready" "Done" Example: status=Done Only returns intents in the given status. |
created.gt | string <date> Example: created.gt=2022-12-10 A filter based on the object's |
created.lt | string <date> Example: created.lt=2022-12-13 A filter based on the object's |
limit | integer Default: 10 A limit on the number of objects to be returned. Limit can range between 1 and 99, and the default is 10. |
page | integer Default: 0 A cursor for pagination across multiple pages of results. |
A dictionary with a extensionIntents
property that contains an array of up to limit
ExtensionIntents.
Extension intent {id} couldn't be found
Production environment
Sandbox environment
Retrieves the details of an ExtensionIntent that has previously been created.
id required | string |
An ExtensionIntent
if a valid id
was provided.
Extension intent {id} couldn't be found
Production environment
Sandbox environment
Confirms the extension of the material to a new plant.
id required | string |
OK
Extension intent {id} couldn't be found
Production environment
Sandbox environment
Marks the intent as rejected by the external system.
id required | string |
message required | string Short description of the reason for rejecting the intent. |
OK
Extension intent {id} couldn't be found
Production environment
Sandbox environment
This endpoint is part of the module “Material Master Sync” for updating the material master content in SPARETECH based on the changes initiated from the external ERP. The current endpoint inserts a new material.
material required | object Object containing the entire material for a specific plant, if exists. The fields in this object are based on the material master headings. |
OK
Material reference already exists.
Production environment
Sandbox environment
This endpoint is part of the module “Material Master Sync” for updating the material master content in SPARETECH based on the changes initiated from the external ERP. The current endpoint applies changes to a material.
reference required | string |
material required | object Object containing the entire material for a specific plant, if exists. The fields in this object are based on the material master headings. |
OK
Material reference and/or plant couldn't be found.
Invalid material reference.
Production environment
Sandbox environment
This endpoint is part of the module “Material Master Sync” for updating the material master content in SPARETECH based on the changes initiated from the external ERP. The current endpoint extends a material to a given plant.
reference required | string |
material required | object Object containing the plant fields. The fields in this object are based on the material master headings. |
OK
Material reference and/or plant couldn't be found.
Plant is already included in material
Material fields should not be part of an extension.
Production environment
Sandbox environment