retraced REST API

• Companies
  • getGet Single Company by ID
  • getList All Companies in my network
• API Keys
  • postCreate a new API Key
  • delDelete Company API Key
• Attachment Templates
  • getList all attachment templates
• Orders
  • postCreate a purchase order
  • postCreate a sales order
  • getGet single purchase order
  • putPUT a purchase order
  • getGet single sales order
  • putPUT a sales order
• Products
  • postCreate New Product
  • getList All Products
  • getGet single Product
  • patchUpdates product fields passed in the request body
  • putUpdate entire product by id
  • getList All Product types

API docs by Redocly

@retracedgmbh/public-api-service/v1 (1.0.0)

Download OpenAPI specification:Download

The retraced API comprises all publicly enabled options to make machine-to-machine changes in the retraced platform: http://retraced.com/. The retraced dashboard uses the same endpoints, but also in addition more. If you wish to use the API of the dashboard, it is possible but not versioned cleanly like the public API. ## Versioning The API is versioned using semantic-release rendering numbers like x.y.z (to be read like major.minor.patch). The major version indicates breaking changes, the minor version non-breaking feature changes or additions, and the patch version internal non-breaking adjustments for internal CI/CD and devops purposes. ## External identifier This API does support being called with your custom identifier (like a SAP ERP ID, Infor Syteline ID). ## Authentication The authentication procedure is passwordless. You have to request the access code with a registered phone number or email. You will receive within 2 minutes the SMS or email with the code to submit again. On successful submission, you will get an access token and refresh token. All calls are authenticated with the access token. Further information on the flow on the specific /auth endpoints.

Companies

All endpoints to modify companies in retraced.

Get Single Company by ID

Authorizations:

bearerAuth

path Parameters

id required

string Examples: RWFWXC1H1M8 QE4ARF7G3VG 13c13921-8e0a-4299-a282-023d9fae25de A hashed id of the company Available options Could be both a: nanoId uuidV4

query Parameters

expand

string

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

Schema not provided

Responses

staging server

https://publicapi.staging.retraced.com/v1/companies/:id

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "officialName": "string",
• "facilityProcesses": [ ]

}

List All Companies in my network

Authorizations:

bearerAuth

query Parameters

page	number >= 0 Default: 0
count	number [ 0 .. 500 ] Default: 15
filter	string <= 512 characters

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

Schema not provided

Responses

staging server

https://publicapi.staging.retraced.com/v1/companies/

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "data": [

  • {

    • "id": "string",
    • "officialName": "string",
    • "facilityProcesses": [ ]

    }

  ],
• "meta": {

  • "count": 0,
  • "pageSize": 0,
  • "page": 0,
  • "totalCount": 0

  }

}

API Keys

Create a new API Key

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

label required

string [ 1 .. 255 ] characters

Responses

staging server

https://publicapi.staging.retraced.com/v1/api-keys/

Request samples

• Payload

Content type

application/json

{

• "label": "string"

}

Response samples

• 200
• 401
• 403
• 404
• 409

Content type

application/json

{

• "label": "string",
• "companyApiKey": "string"

}

Delete Company API Key

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

label required

string [ 1 .. 255 ] characters

Responses

staging server

https://publicapi.staging.retraced.com/v1/api-keys/

Request samples

• Payload

Content type

application/json

{

• "label": "string"

}

Response samples

• 204
• 401
• 403
• 404

Content type

application/json

null

Attachment Templates

List all attachment templates

Authorizations:

bearerAuth

query Parameters

page	number >= 0 Default: 0
count	number [ 0 .. 500 ] Default: 15
name	string
sort	string
filter	string <= 512 characters

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

Schema not provided

Responses

staging server

https://publicapi.staging.retraced.com/v1/attachment-templates/

Response samples

• 200
• 401
• 403

Content type

application/json

{

• "data": [

  • {

    • "id": "string",
    • "name": "string",
    • "description": "string"

    }

  ],
• "meta": {

  • "count": 0,
  • "pageSize": 0,
  • "page": 0,
  • "totalCount": 0

  }

}

Orders

Create a purchase order

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

orderNumber required	string non-empty
	Array of strings or null
	string or null
	string or null
attachmentTemplateId required	string non-empty
	Array of objects
required	object
required	object
	object or null
required	Array of objects non-empty
	Array of strings or null
	string or null
	string or null

Responses

staging server

https://publicapi.staging.retraced.com/v1/orders/purchases

Request samples

• Payload

Content type

application/json

{

• "orderNumber": "string",
• "orderTags": [

  • "string"

  ],
• "orderDate": "2019-08-24T14:15:22Z",
• "deliveryDate": "2019-08-24T14:15:22Z",
• "attachmentTemplateId": "string",
• "attachments": [

  • {

    • "remoteFileUrl": "string",
    • "type": "PURCHASE_ORDER",
    • "name": "string",
    • "reference": "string",
    • "description": "string"

    }

  ],
• "buyer": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "supplier": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "receiver": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "lines": [

  • {

    • "productId": "string",
    • "unit": "LITRE",
    • "quantity": 0,
    • "secondaryUnit": "KILOGRAM",
    • "secondaryQuantity": 0

    }

  ],
• "responsibleUserEmails": [

  • "string"

  ],
• "status": "IN_PROGRESS",
• "agreedDeliveryDate": "2019-08-24T14:15:22Z"

}

Response samples

• 202
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "createdAt": "string"

}

Create a sales order

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

orderNumber required	string non-empty
	Array of strings or null
	string or null
	string or null
attachmentTemplateId required	string non-empty
	Array of objects
required	object
required	object
	object or null
required	Array of objects non-empty
	Array of strings or null
	string or null
	string or null

Responses

staging server

https://publicapi.staging.retraced.com/v1/orders/sales

Request samples

• Payload

Content type

application/json

{

• "orderNumber": "string",
• "orderTags": [

  • "string"

  ],
• "orderDate": "2019-08-24T14:15:22Z",
• "deliveryDate": "2019-08-24T14:15:22Z",
• "attachmentTemplateId": "string",
• "attachments": [

  • {

    • "remoteFileUrl": "string",
    • "type": "PURCHASE_ORDER",
    • "name": "string",
    • "reference": "string",
    • "description": "string"

    }

  ],
• "buyer": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "supplier": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "receiver": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "lines": [

  • {

    • "productId": "string",
    • "unit": "LITRE",
    • "quantity": 0,
    • "secondaryUnit": "KILOGRAM",
    • "secondaryQuantity": 0

    }

  ],
• "responsibleUserEmails": [

  • "string"

  ],
• "status": "IN_PROGRESS",
• "agreedDeliveryDate": "2019-08-24T14:15:22Z"

}

Response samples

• 202
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "createdAt": "string"

}

Get single purchase order

Authorizations:

bearerAuth

path Parameters

id required

string

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

Schema not provided

Responses

staging server

https://publicapi.staging.retraced.com/v1/orders/purchases/{id}

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "orderNumber": "string",
• "buyerCompany": {

  • "id": "string",
  • "facilityProcesses": "string"

  },
• "supplierCompany": {

  • "id": "string",
  • "facilityProcesses": "string"

  },
• "attachmentTemplate": {

  • "id": "string"

  },
• "tracingOrderTags": "string",
• "supplierCompanyId": "string",
• "buyerCompanyId": "string",
• "facilityProcess": "string",
• "receiverCompanyId": "string",
• "orderDate": "2019-08-24T14:15:22Z",
• "deliveryDate": "2019-08-24T14:15:22Z",
• "status": "string",
• "orderTags": "string",
• "agreedDeliveryDate": "string",
• "attachments": [

  • {

    • "id": "string",
    • "remoteFileUrl": "string",
    • "type": "string"

    }

  ],
• "responsibleUsers": [

  • {

    • "userId": "string",
    • "email": "string"

    }

  ],
• "lines": [

  • {

    • "productId": "string",
    • "unit": "string",
    • "quantity": 0,
    • "secondaryUnit": "string",
    • "secondaryQuantity": 0

    }

  ]

}

PUT a purchase order

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

orderNumber required	string non-empty
	Array of strings or null
	string or null
	string or null
attachmentTemplateId required	string non-empty
	Array of objects
required	object
required	object
	object or null
required	Array of objects non-empty
	Array of strings or null
	string or null
	string or null

Responses

staging server

https://publicapi.staging.retraced.com/v1/orders/purchases/{id}

Request samples

• Payload

Content type

application/json

{

• "orderNumber": "string",
• "orderTags": [

  • "string"

  ],
• "orderDate": "2019-08-24T14:15:22Z",
• "deliveryDate": "2019-08-24T14:15:22Z",
• "attachmentTemplateId": "string",
• "attachments": [

  • {

    • "remoteFileUrl": "string",
    • "type": "PURCHASE_ORDER",
    • "name": "string",
    • "reference": "string",
    • "description": "string"

    }

  ],
• "buyer": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "supplier": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "receiver": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "lines": [

  • {

    • "productId": "string",
    • "unit": "LITRE",
    • "quantity": 0,
    • "secondaryUnit": "KILOGRAM",
    • "secondaryQuantity": 0

    }

  ],
• "responsibleUserEmails": [

  • "string"

  ],
• "status": "IN_PROGRESS",
• "agreedDeliveryDate": "2019-08-24T14:15:22Z"

}

Response samples

• 202
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "updatedAt": "string"

}

Get single sales order

Authorizations:

bearerAuth

path Parameters

id required

string

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

Schema not provided

Responses

staging server

https://publicapi.staging.retraced.com/v1/orders/sales/{id}

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "orderNumber": "string",
• "buyerCompany": {

  • "id": "string",
  • "facilityProcesses": "string"

  },
• "supplierCompany": {

  • "id": "string",
  • "facilityProcesses": "string"

  },
• "attachmentTemplate": {

  • "id": "string"

  },
• "tracingOrderTags": "string",
• "supplierCompanyId": "string",
• "buyerCompanyId": "string",
• "facilityProcess": "string",
• "receiverCompanyId": "string",
• "orderDate": "2019-08-24T14:15:22Z",
• "deliveryDate": "2019-08-24T14:15:22Z",
• "status": "string",
• "orderTags": "string",
• "agreedDeliveryDate": "string",
• "attachments": [

  • {

    • "id": "string",
    • "remoteFileUrl": "string",
    • "type": "string"

    }

  ],
• "responsibleUsers": [

  • {

    • "userId": "string",
    • "email": "string"

    }

  ],
• "lines": [

  • {

    • "productId": "string",
    • "unit": "string",
    • "quantity": 0,
    • "secondaryUnit": "string",
    • "secondaryQuantity": 0

    }

  ]

}

PUT a sales order

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

orderNumber required	string non-empty
	Array of strings or null
	string or null
	string or null
attachmentTemplateId required	string non-empty
	Array of objects
required	object
required	object
	object or null
required	Array of objects non-empty
	Array of strings or null
	string or null
	string or null

Responses

staging server

https://publicapi.staging.retraced.com/v1/orders/sales/{id}

Request samples

• Payload

Content type

application/json

{

• "orderNumber": "string",
• "orderTags": [

  • "string"

  ],
• "orderDate": "2019-08-24T14:15:22Z",
• "deliveryDate": "2019-08-24T14:15:22Z",
• "attachmentTemplateId": "string",
• "attachments": [

  • {

    • "remoteFileUrl": "string",
    • "type": "PURCHASE_ORDER",
    • "name": "string",
    • "reference": "string",
    • "description": "string"

    }

  ],
• "buyer": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "supplier": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "receiver": {

  • "id": "string",
  • "facilityProcesses": [

    • "WEAVING_MILL"

    ]

  },
• "lines": [

  • {

    • "productId": "string",
    • "unit": "LITRE",
    • "quantity": 0,
    • "secondaryUnit": "KILOGRAM",
    • "secondaryQuantity": 0

    }

  ],
• "responsibleUserEmails": [

  • "string"

  ],
• "status": "IN_PROGRESS",
• "agreedDeliveryDate": "2019-08-24T14:15:22Z"

}

Response samples

• 202
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "updatedAt": "string"

}

Products

Create New Product

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

name required	string [ 1 .. 255 ] characters
productCategoryId required	string non-empty Once added, product category cannot be changed.
code required	string non-empty
	string or null
	boolean or null
supplierCompanyIds	Array of strings
vendorCompanyIds	Array of strings
	Array of objects
	object
	Array of objects
	object or null
	Array of objects
	Array of objects
	Array of objects <= 20 items
	Array of objects Only allowed for Product category id of Fabrics.
	Array of objects
	Array of objects

Responses

staging server

https://publicapi.staging.retraced.com/v1/products/

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "productCategoryId": "string",
• "code": "string",
• "description": "string",
• "isProductComponent": true,
• "supplierCompanyIds": [

  • "string"

  ],
• "vendorCompanyIds": [

  • "string"

  ],
• "collections": [

  • {

    • "name": "string"

    }

  ],
• "productProperties": {

  • "brand": [

    • "string"

    ],
  • "department": [

    • "string"

    ],
  • "season": [

    • "string"

    ]

  },
• "materials": [

  • {

    • "materialId": "string",
    • "percentage": "string",
    • "weight": 0,
    • "originCountry": "string"

    }

  ],
• "weight": {

  • "unit": "LITRE",
  • "value": 0

  },
• "colors": [

  • {

    • "name": "string",
    • "imageRemoteUrl": "string"

    }

  ],
• "variations": [

  • {

    • "color": "string",
    • "otherAttributes": "string",
    • "sku": "string"

    }

  ],
• "imageList": [

  • {

    • "remoteUrl": "string"

    }

  ],
• "productCategoryFields": [

  • {

    • "fieldName": "string",
    • "fieldType": "NUMBER_UOM",
    • "fieldValue": {

      • "value": "string",
      • "unit": "LITRE"

      },
    • "standardFieldName": "FABRIC_WEIGHT"

    }

  ],
• "bom": [

  • {

    • "childProductId": "string",
    • "quantity": 0,
    • "unit": "LITRE",
    • "weight": {

      • "unit": "LITRE",
      • "value": 0

      },
    • "isMainComponent": 0,
    • "placementId": "string"

    }

  ],
• "externalProductTypes": [

  • {

    • "externalId": "string",
    • "externalName": "string"

    }

  ]

}

Response samples

• 202
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "createdAt": "string"

}

List All Products

Authorizations:

bearerAuth

query Parameters

supplierCompanyIds	string
page	number >= 0 Default: 0
count	number [ 0 .. 500 ] Default: 15
sort	string
filter	string <= 512 characters Examples: isProductComponent=true productCategoryId=xyz123

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

Schema not provided

Responses

staging server

https://publicapi.staging.retraced.com/v1/products/

Response samples

• 200
• 401
• 403

Content type

application/json

{

• "data": [

  • {

    • "id": "string",
    • "code": "string",
    • "name": "string",
    • "description": "string",
    • "isProductComponent": true,
    • "collections": [

      • {

        • "name": "string"

        }

      ],
    • "productLevelName": "string",
    • "productCategoryName": "string",
    • "colors": [

      • {

        • "imageUrl": "string",
        • "name": "string",
        • "imageRemoteUrl": "string"

        }

      ],
    • "variations": [

      • null

      ],
    • "suppliers": [

      • {

        • "id": "string",
        • "name": "string",
        • "country": "string"

        }

      ],
    • "vendors": [

      • {

        • "id": "string",
        • "name": "string",
        • "country": "string"

        }

      ],
    • "materials": [

      • {

        • "id": "string",
        • "materialId": "string",
        • "name": "string",
        • "description": "string",
        • "category": "string",
        • "percentage": "string",
        • "weight": 0,
        • "originCountry": "string",
        • "insights": "string",
        • "imageFileId": "string",
        • "imageFileUrl": "string",
        • "quantityUnits": [ ],
        • "weightUnits": [ ],
        • "tags": "string",
        • "brandId": "string",
        • "isRecycled": 0,
        • "isSynthetic": 0,
        • "externalProductTypes": [

          • {

            • "id": "string",
            • "name": "string",
            • "externalId": "string",
            • "externalName": "string",
            • "retracedProductTypeId": "string",
            • "retracedMaterialId": "string",
            • "createdAt": "string",
            • "assetTable": "string",
            • "companyId": "string"

            }

          ]

        }

      ],
    • "imageList": [

      • {

        • "id": "string",
        • "url": "string",
        • "remoteUrl": "string",
        • "fileType": "string"

        }

      ],
    • "weight": 0,
    • "weightUnit": "string",
    • "productProperties": {

      • "brand": [

        • {

          • "name": "string",
          • "category": "string",
          • "productId": "string",
          • "propertyId": "string"

          }

        ],
      • "department": [

        • {

          • "name": "string",
          • "category": "string",
          • "productId": "string",
          • "propertyId": "string"

          }

        ],
      • "season": [

        • {

          • "name": "string",
          • "category": "string",
          • "productId": "string",
          • "propertyId": "string"

          }

        ]

      },
    • "categoryFieldValues": [

      • {

        • "id": "string",
        • "fieldName": "string",
        • "fieldValue": {

          • "value": { }

          }

        }

      ],
    • "bom": [

      • {

        • "childProductId": "string",
        • "quantity": 0,
        • "unit": "LITRE",
        • "weight": 0,
        • "placementId": "string",
        • "weightUnit": "LITRE",
        • "isMainComponent": 0

        }

      ],
    • "externalProductTypes": [

      • {

        • "id": "string",
        • "name": "string",
        • "externalId": "string",
        • "externalName": "string",
        • "retracedProductTypeId": "string",
        • "createdAt": "string",
        • "assetTable": "string",
        • "companyId": "string"

        }

      ]

    }

  ],
• "meta": {

  • "count": 0,
  • "pageSize": 0,
  • "page": 0,
  • "totalCount": 0

  }

}

Get single Product

Authorizations:

bearerAuth

path Parameters

id required

string non-empty

query Parameters

supplyChain	boolean Default: false
attributes	boolean Default: false
variations	boolean Default: false
orders	boolean Default: false

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

Schema not provided

Responses

staging server

https://publicapi.staging.retraced.com/v1/products/:id

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "code": "string",
• "name": "string",
• "description": "string",
• "isProductComponent": true,
• "collections": [

  • {

    • "name": "string"

    }

  ],
• "productLevelName": "string",
• "productCategoryName": "string",
• "colors": [

  • {

    • "imageUrl": "string",
    • "name": "string",
    • "imageRemoteUrl": "string"

    }

  ],
• "variations": [

  • null

  ],
• "suppliers": [

  • {

    • "id": "string",
    • "name": "string",
    • "country": "string"

    }

  ],
• "vendors": [

  • {

    • "id": "string",
    • "name": "string",
    • "country": "string"

    }

  ],
• "materials": [

  • {

    • "id": "string",
    • "materialId": "string",
    • "name": "string",
    • "description": "string",
    • "category": "string",
    • "percentage": "string",
    • "weight": 0,
    • "originCountry": "string",
    • "insights": "string",
    • "imageFileId": "string",
    • "imageFileUrl": "string",
    • "quantityUnits": [ ],
    • "weightUnits": [ ],
    • "tags": "string",
    • "brandId": "string",
    • "isRecycled": 0,
    • "isSynthetic": 0,
    • "externalProductTypes": [

      • {

        • "id": "string",
        • "name": "string",
        • "externalId": "string",
        • "externalName": "string",
        • "retracedProductTypeId": "string",
        • "retracedMaterialId": "string",
        • "createdAt": "string",
        • "assetTable": "string",
        • "companyId": "string"

        }

      ]

    }

  ],
• "imageList": [

  • {

    • "id": "string",
    • "url": "string",
    • "remoteUrl": "string",
    • "fileType": "string"

    }

  ],
• "weight": 0,
• "weightUnit": "string",
• "productProperties": {

  • "brand": [

    • {

      • "name": "string",
      • "category": "string",
      • "productId": "string",
      • "propertyId": "string"

      }

    ],
  • "department": [

    • {

      • "name": "string",
      • "category": "string",
      • "productId": "string",
      • "propertyId": "string"

      }

    ],
  • "season": [

    • {

      • "name": "string",
      • "category": "string",
      • "productId": "string",
      • "propertyId": "string"

      }

    ]

  },
• "categoryFieldValues": [

  • {

    • "id": "string",
    • "fieldName": "string",
    • "fieldValue": {

      • "value": { }

      }

    }

  ],
• "bom": [

  • {

    • "childProductId": "string",
    • "quantity": 0,
    • "unit": "LITRE",
    • "weight": 0,
    • "placementId": "string",
    • "weightUnit": "LITRE",
    • "isMainComponent": 0

    }

  ],
• "externalProductTypes": [

  • {

    • "id": "string",
    • "name": "string",
    • "externalId": "string",
    • "externalName": "string",
    • "retracedProductTypeId": "string",
    • "createdAt": "string",
    • "assetTable": "string",
    • "companyId": "string"

    }

  ]

}

Updates product fields passed in the request body

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

name	string <= 255 characters
code	string
	string or null
	boolean or null
supplierCompanyIds	Array of strings
isStoryActive	boolean
vendorCompanyIds	Array of strings
	Array of objects
	object
	Array of objects
	object or null
	Array of objects
	Array of objects
	Array of objects <= 20 items
	Array of objects Only allowed for Product category id of Fabrics.
	Array of objects
	Array of objects

Responses

staging server

https://publicapi.staging.retraced.com/v1/products/:id

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "code": "string",
• "description": "string",
• "isProductComponent": true,
• "supplierCompanyIds": [

  • "string"

  ],
• "isStoryActive": true,
• "vendorCompanyIds": [

  • "string"

  ],
• "collections": [

  • {

    • "name": "string"

    }

  ],
• "productProperties": {

  • "brand": [

    • "string"

    ],
  • "department": [

    • "string"

    ],
  • "season": [

    • "string"

    ]

  },
• "materials": [

  • {

    • "materialId": "string",
    • "percentage": "string",
    • "weight": 0,
    • "originCountry": "string"

    }

  ],
• "weight": {

  • "unit": "LITRE",
  • "value": 0

  },
• "colors": [

  • {

    • "name": "string",
    • "imageRemoteUrl": "string"

    }

  ],
• "variations": [

  • {

    • "color": "string",
    • "otherAttributes": "string",
    • "sku": "string"

    }

  ],
• "imageList": [

  • {

    • "remoteUrl": "string"

    }

  ],
• "productCategoryFields": [

  • {

    • "fieldName": "string",
    • "fieldType": "NUMBER_UOM",
    • "fieldValue": {

      • "unit": "LITRE",
      • "value": "string"

      },
    • "standardFieldName": "FABRIC_WEIGHT"

    }

  ],
• "bom": [

  • {

    • "childProductId": "string",
    • "quantity": 0,
    • "unit": "LITRE",
    • "weight": {

      • "unit": "LITRE",
      • "value": 0

      },
    • "isMainComponent": 0,
    • "placementId": "string"

    }

  ],
• "externalProductTypes": [

  • {

    • "externalId": "string",
    • "externalName": "string"

    }

  ]

}

Response samples

• 202
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "updatedAt": "string"

}

Update entire product by id

Authorizations:

bearerAuth

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

name required	string [ 1 .. 255 ] characters
code required	string non-empty
	string or null
	boolean or null
isStoryActive	boolean
supplierCompanyIds	Array of strings
vendorCompanyIds	Array of strings
	Array of objects
	object
	Array of objects
	object or null
	Array of objects
	Array of objects
	Array of objects <= 20 items
	Array of objects Only allowed for Product category id of Fabrics.
	Array of objects
	Array of objects

Responses

staging server

https://publicapi.staging.retraced.com/v1/products/:id

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "code": "string",
• "description": "string",
• "isProductComponent": true,
• "isStoryActive": true,
• "supplierCompanyIds": [

  • "string"

  ],
• "vendorCompanyIds": [

  • "string"

  ],
• "collections": [

  • {

    • "name": "string"

    }

  ],
• "productProperties": {

  • "brand": [

    • "string"

    ],
  • "department": [

    • "string"

    ],
  • "season": [

    • "string"

    ]

  },
• "materials": [

  • {

    • "materialId": "string",
    • "percentage": "string",
    • "weight": 0,
    • "originCountry": "string"

    }

  ],
• "weight": {

  • "unit": "LITRE",
  • "value": 0

  },
• "colors": [

  • {

    • "name": "string",
    • "imageRemoteUrl": "string"

    }

  ],
• "variations": [

  • {

    • "color": "string",
    • "otherAttributes": "string",
    • "sku": "string"

    }

  ],
• "imageList": [

  • {

    • "remoteUrl": "string"

    }

  ],
• "productCategoryFields": [

  • {

    • "fieldName": "string",
    • "fieldType": "NUMBER_UOM",
    • "fieldValue": {

      • "unit": "LITRE",
      • "value": "string"

      },
    • "standardFieldName": "FABRIC_WEIGHT"

    }

  ],
• "bom": [

  • {

    • "childProductId": "string",
    • "quantity": 0,
    • "unit": "LITRE",
    • "weight": {

      • "unit": "LITRE",
      • "value": 0

      },
    • "isMainComponent": 0,
    • "placementId": "string"

    }

  ],
• "externalProductTypes": [

  • {

    • "externalId": "string",
    • "externalName": "string"

    }

  ]

}

Response samples

• 202
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "updatedAt": "string"

}

List All Product types

Authorizations:

bearerAuth

query Parameters

page	number >= 0 Default: 0
count	number [ 1 .. 1000 ] Default: 500
sort	string
filter	string <= 512 characters

header Parameters

Accept

string Example: application/json

Request Body schema: application/json

Schema not provided

Responses

staging server

https://publicapi.staging.retraced.com/v1/products/types/

Response samples

• 200
• 401
• 403

Content type

application/json

{

• "data": [

  • {

    • "id": "string",
    • "name": "string",
    • "parentId": "string",
    • "parentName": "string",
    • "externalId": "string",
    • "externalName": "string",
    • "retracedProductTypeId": "string",
    • "updatedAt": "2019-08-24T14:15:22Z"

    }

  ],
• "meta": {

  • "count": 0,
  • "pageSize": 0,
  • "page": 0,
  • "totalCount": 0

  }

}