openapi: 3.0.1 info: title: Infigo description: Infigo API Documentation contact: name: Infigo support url: https://infigosoftware.zendesk.com/hc/en-us/requests/new email: infigo@infigosupport.com license: name: Infigo url: https://infigo.net version: '12474' x-logo: https://resources.public.infigosoftware.rocks/infigo/logo/infigo-logo-colour.svg x-providerName: infigo.net x-apisguru-categories: software servers: - url: 'https://infigo.platform.url.com/services/api' description: Infigo paths: '/account/{id}': description: 'Returns cookie ticket based on Email address passed in. It will also create a new user in the system if it doesnt exist. The cookie name is also passed along. If the cookie name is not passed, the AppHarbor security plug-in is used. **use SSOCookie endpoint instead**' get: tags: - Account summary: Retrieve authentication cookie description: 'Returns cookie ticket based on Email address passed in. It will also create a new user in the system if it doesnt exist. The cookie name is also passed along. If the cookie name is not passed, the AppHarbor security plug-in is used. **use SSOCookie endpoint instead**' parameters: - name: id in: path description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. required: true schema: type: string description: '' responses: '200': description: The system has successfully generated a token based on the provided information. content: application/json: schema: $ref: '#/components/schemas/InfigoApiCustomerToken' application/xml: schema: $ref: '#/components/schemas/InfigoApiCustomerToken' '404': description: 'This situation occurs when registration is prohibited in the system, and the attempt to find an existing customer fails.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' deprecated: true /ActionController/GetStatus: description: Gets the status of a thumbnail generation action. The actionId parameter is required to identify the specific action. get: tags: - Action summary: Get status of thumbnail description: Gets the status of a thumbnail generation action. The actionId parameter is required to identify the specific action. parameters: - name: actionId in: query description: '' required: true schema: type: string description: '' format: uuid responses: '200': description: Record found successfully and details about it content: application/json: schema: $ref: '#/components/schemas/InfigoImmediateActionRecordDisplayModel' application/xml: schema: $ref: '#/components/schemas/InfigoImmediateActionRecordDisplayModel' '404': description: Action with provided it not found content: application/json: schema: $ref: '#/components/schemas/InfigoApiNotFoundError' application/xml: schema: $ref: '#/components/schemas/InfigoApiNotFoundError' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /addressbook: description: This operation returns a list of all address books available within the system. get: tags: - AddressBook summary: Get address books description: This operation returns a list of all address books available within the system. responses: '200': description: Successfully retrieved address books content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoApiAddressBookModel' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoApiAddressBookModel' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /addressbook/paginated: description: This operation returns a list of all address books paginated available within the system. get: tags: - AddressBook summary: Get address books paginated description: This operation returns a list of all address books paginated available within the system. parameters: - name: Search in: query description: '' schema: type: string description: '' nullable: true - name: OrderBy in: query description: | Possible values: `0` - Id `1` - Name required: true schema: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Id `1` - Name x-enum-descriptions: - Id - Name x-ms-enum: - Id - Name x-enumNames: - Id - Name x-enum-varnames: - Id - Name - name: SortDirection in: query description: | Possible values: `0` - Asc `1` - Desc required: true schema: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Asc `1` - Desc x-enum-descriptions: - Asc - Desc x-ms-enum: - Asc - Desc x-enumNames: - Asc - Desc x-enum-varnames: - Asc - Desc - name: PageIndex in: query description: '' required: true schema: type: integer description: '' - name: PerPage in: query description: '' required: true schema: type: integer description: '' responses: '200': description: Successfully retrieved address books content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoApiAddressBookModel' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoApiAddressBookModel' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/addressbook/getbyid/{id}': description: This operation retrieves detailed information about a customer based on the provided Customer identifier. get: tags: - AddressBook summary: Get address book description: This operation retrieves detailed information about a customer based on the provided Customer identifier. parameters: - name: id in: path description: '' required: true schema: type: integer description: '' responses: '200': description: Details about address book retrieved successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiAddressBookModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiAddressBookModel' '404': description: Address book with provided identifier was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /addressbook/insert: description: Created a new address book with provided details. post: tags: - AddressBook summary: Create address book description: Created a new address book with provided details. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiAddressBookModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiAddressBookModel' responses: '200': description: Address book was created successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: Validation for provided details failed content: application/json: schema: $ref: '#/components/schemas/InfigoApiErrorModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiErrorModel' '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '/addressbook/update/{id}': description: Update a existing address book with the provided identifier. post: tags: - AddressBook summary: Update address book description: Update a existing address book with the provided identifier. parameters: - name: id in: path description: '' required: true schema: type: integer description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiAddressBookModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiAddressBookModel' responses: '200': description: Address book was updated successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: Validation for provided details failed content: application/json: schema: $ref: '#/components/schemas/InfigoApiErrorModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiErrorModel' '404': description: Address book with provided identifier was not found '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '/addressbook/delete/{id}': description: Delete a existing address book with the provided identifier. post: tags: - AddressBook summary: Delete address book description: Delete a existing address book with the provided identifier. parameters: - name: id in: path description: '' required: true schema: type: integer description: '' responses: '200': description: Address book was deleted successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: Validation for provided details failed '404': description: Address book with provided identifier was not found '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string /addressbook/assign: description: 'Assign address book to a Customer, Customer role or to a Department.' post: tags: - AddressBook summary: Assign address book description: 'Assign address book to a Customer, Customer role or to a Department.' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoAssignAddressBookModel' application/xml: schema: $ref: '#/components/schemas/InfigoAssignAddressBookModel' responses: '200': description: Address book was assigned successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: Validation for provided details failed content: application/json: schema: $ref: '#/components/schemas/InfigoApiErrorModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiErrorModel' '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '/address/getallbycustomerid/{id}': description: This operation returns a list of all customer addresses available within the system. get: tags: - Address summary: Get customer addresses description: This operation returns a list of all customer addresses available within the system. parameters: - name: customerId in: query description: '' required: true schema: type: integer description: '' responses: '200': description: List of customer addresses retrieved successfully '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/address/getbyid/{id}': description: This operation retrieves detailed information about an address with the provided address identifier. get: tags: - Address summary: Get an address description: This operation retrieves detailed information about an address with the provided address identifier. parameters: - name: id in: path description: '' required: true schema: type: integer description: '' responses: '200': description: Details about address retrieved successfully '404': description: Address with provided identifier was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/address/update/{id}': description: Update a existing address with the provided identifier. post: tags: - Address summary: Update address description: Update a existing address with the provided identifier. parameters: - name: id in: path description: '' required: true schema: type: integer description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiAddress' application/xml: schema: $ref: '#/components/schemas/InfigoApiAddress' responses: '200': description: Address was updated successfully '400': description: Validation for provided details failed '404': description: Address with provided identifier was not found '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string /address/delete: description: Delete a existing address with the provided identifier. post: tags: - Address summary: Delete address description: Delete a existing address with the provided identifier. parameters: - name: id in: query description: '' required: true schema: type: integer description: '' responses: '200': description: Address was deleted successfully '400': description: Validation for provided details failed '404': description: Address with provided identifier was not found '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string /address/assign: description: 'Assign address to a Customer, Department or to an Address Book.' post: tags: - Address summary: Assign address description: 'Assign address to a Customer, Department or to an Address Book.' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoAssignApiAddressModel' application/xml: schema: $ref: '#/components/schemas/InfigoAssignApiAddressModel' responses: '200': description: Address was assigned successfully '400': description: Validation for provided details failed '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '/auth/{id}': description: This operation retrieves the authentication record associated with a specific API Key get: tags: - Auth summary: Retrieve authentication record description: This operation retrieves the authentication record associated with a specific API Key parameters: - name: id in: path description: | The API Key of the record. required: true schema: type: string description: '' responses: '200': description: Authentication record content: application/json: schema: $ref: '#/components/schemas/InfigoAuthentication' application/xml: schema: $ref: '#/components/schemas/InfigoAuthentication' '404': description: No Authentication Record found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/batch/get/{id}': description: Get job details get: tags: - Batch summary: Get Job description: Get job details parameters: - name: id in: path description: | Should be in GUID format required: true schema: type: string description: '' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InfigoBatchJobItemsInfoModel' application/xml: schema: $ref: '#/components/schemas/InfigoBatchJobItemsInfoModel' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /batch/enqueue: description: Add batch job items to processing queue. post: tags: - Batch summary: Enqueue description: Add batch job items to processing queue. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiBatchJobsModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiBatchJobsModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InfigoBatchJobCallbackModel' application/xml: schema: $ref: '#/components/schemas/InfigoBatchJobCallbackModel' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /capability/checkstatus: description: 'Check capability status. Depending on the category, a specific context needs to be passed.' post: tags: - Capability summary: Status description: 'Check capability status. Depending on the category, a specific context needs to be passed.' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoCheckStatusCapabilityRequest' application/xml: schema: $ref: '#/components/schemas/InfigoCheckStatusCapabilityRequest' responses: '200': description: Setting info based on provided context content: application/json: schema: $ref: '#/components/schemas/InfigoCapabilityResponse' application/xml: schema: $ref: '#/components/schemas/InfigoCapabilityResponse' '400': description: Validation for provided details failed content: application/json: schema: $ref: '#/components/schemas/InfigoApiErrorModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiErrorModel' '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string /catalog/category: description: This operation returns a list of all root category identifiers available within the system. get: tags: - Catalog summary: Category List description: This operation returns a list of all root category identifiers available within the system. responses: '200': description: List of category Ids content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' post: tags: - Catalog summary: Create a new category description: Create a new Category in the catalogue requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoCreateCategoryRequest' application/xml: schema: $ref: '#/components/schemas/InfigoCreateCategoryRequest' responses: '200': description: New category Id content: text/plain: schema: type: integer description: '' application/json: schema: type: integer description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/product: description: Returns a list of all product identifier in a category or available in whole the system get: tags: - Catalog summary: Product list description: Returns a list of all product identifier in a category or available in whole the system parameters: - name: id in: query description: | Category identifier. If set, only products from that category are returned. Otherwise, all products are returned. schema: type: integer description: '' nullable: true - name: groupId in: query description: | Group identifier. If set, only products from that group are returned. Otherwise, all products are returned. schema: type: integer description: '' nullable: true responses: '200': description: List of product ids content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '404': description: No category was found by supplied Category identifier content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/catalog/product/{id}': description: Get detailed information for a product within the system get: tags: - Catalog summary: Product details description: Get detailed information for a product within the system parameters: - name: id in: path description: | Product id required: true schema: type: integer description: '' - name: thumbnailSize in: query description: | Optional width of the thumbnail image schema: type: integer description: '' nullable: true - name: previewSize in: query description: | Optional width of the preview image schema: type: integer description: '' nullable: true responses: '200': description: Product details content: application/json: schema: $ref: '#/components/schemas/InfigoProductInfo' application/xml: schema: $ref: '#/components/schemas/InfigoProductInfo' '404': description: No product was found by supplied product id content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/catalog/product/{id}/delete': description: Deleting a product from the system will not affect any orders that were placed with this product. post: tags: - Catalog summary: Delete a product description: Deleting a product from the system will not affect any orders that were placed with this product. parameters: - name: id in: path description: | Product id required: true schema: type: integer description: '' responses: '204': description: Product deleted with success '404': description: No product was found by supplied product id content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/product/create: description: No documentation post: tags: - Catalog summary: Create a product description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoCreateProductRequest' application/xml: schema: $ref: '#/components/schemas/InfigoCreateProductRequest' responses: '200': description: 'The product was successfully created, and the product ID will be provided in the response.' content: text/plain: schema: type: integer description: '' application/json: schema: type: integer description: '' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/product/update: description: No documentation post: tags: - Catalog summary: Update a product description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateProductRequest' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateProductRequest' responses: '200': description: A success flag will be returned to indicate whether the product was updated successfully. content: text/plain: schema: type: boolean description: '' application/json: schema: type: boolean description: '' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/catalog/product/{id}/artwork': description: Upload a PDF against an existing product post: tags: - Catalog summary: Upload artwork description: Upload a PDF against an existing product parameters: - name: id in: path description: | Product id required: true schema: type: integer description: '' requestBody: description: '' content: multipart/form-data: schema: required: - File type: object properties: File: type: string format: binary responses: '200': description: A success flag will be returned to indicate whether the artwork was attached successfully. content: text/plain: schema: type: boolean description: '' application/json: schema: type: boolean description: '' '404': description: No product with provided ID was found '415': description: File is not a valid PDF '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/product/stock: description: Update stock level for a product post: tags: - Catalog summary: Update stock description: Update stock level for a product requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateStockQuantityModel' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateStockQuantityModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateStockQuantityResultModel' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateStockQuantityResultModel' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/catalog/product/{id}/image': description: Upload a image to an existing product post: tags: - Catalog summary: Upload product image description: Upload a image to an existing product parameters: - name: id in: path description: | Product Id required: true schema: type: integer description: '' - name: clearExisting in: query description: | Remove all existing images before uploading a new one schema: type: boolean description: '' - name: displayOrder in: query description: | Product image display order schema: type: integer description: '' - name: seoName in: query description: | Image seo name schema: type: string description: '' nullable: true requestBody: description: '' content: multipart/form-data: schema: required: - File type: object properties: File: type: string format: binary responses: '200': description: The image was successfully uploaded. '400': description: The file is not recognized as an image '406': description: The file is not recognized as an image '404': description: No product with the provided ID was found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/catalog/category/{id}': description: Get detailed information for a category within the system get: tags: - Catalog summary: Category details description: Get detailed information for a category within the system parameters: - name: id in: path description: | Category id required: true schema: type: integer description: '' - name: thumbnailSize in: query description: | Optional width of the preview image schema: type: integer description: '' nullable: true - name: previewSize in: query description: | Optional width of the thumbnail image schema: type: integer description: '' nullable: true responses: '200': description: Category details content: application/json: schema: $ref: '#/components/schemas/InfigoCategoryInfo' application/xml: schema: $ref: '#/components/schemas/InfigoCategoryInfo' '404': description: No category with the provided Id was found content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/catalog/product/{productId}/template': description: This will provide the Artwork file that was uploaded to an Infigo Product. Please note that only Infigo products are currently supported. get: tags: - Catalog summary: Retrieve product artwork description: This will provide the Artwork file that was uploaded to an Infigo Product. Please note that only Infigo products are currently supported. parameters: - name: productId in: path description: | Infigo product Id required: true schema: type: integer description: '' responses: '200': description: Product artwork '404': description: No **Infigo** product with the provided ID was found. '405': description: 'If the Infigo platform is not configured to have Catfish sync enabled, you will receive a Method not allowed error.' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/product/synclocal: description: 'Working in context of Infigo products, verify whether the products retrieved from the server have the same checksums for artworks as those on the client side.' post: tags: - Catalog summary: Synchronizes the client list with the server description: 'Working in context of Infigo products, verify whether the products retrieved from the server have the same checksums for artworks as those on the client side.' requestBody: description: Parameter content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoProductTemplateSyncInfo' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoProductTemplateSyncInfo' description: '' responses: '200': description: Retrieve information about product templates from the server for the specified products. content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoProductTemplateSyncInfo' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoProductTemplateSyncInfo' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/product/syncremote: description: 'Working in context of Infigo products, verify whether the products retrieved from the server have the same checksums for artworks as those on the client side.' post: tags: - Catalog summary: Synchronizes the infigo product sync info with the server description: 'Working in context of Infigo products, verify whether the products retrieved from the server have the same checksums for artworks as those on the client side.' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoProductTemplateSyncInfo' application/xml: schema: $ref: '#/components/schemas/InfigoProductTemplateSyncInfo' responses: '200': description: Retrieve a flag that indicates whether the client-side template and the template from the Infigo server have matching checksums. content: text/plain: schema: type: boolean description: '' application/json: schema: type: boolean description: '' '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/products/search: description: No documentation get: tags: - Catalog summary: Search products description: '' parameters: - name: Keywords in: query description: | Search for a product keyword, with the default search scope in `Product Name`, and additionally based on the flags from the request in `SKU` and `Description`. schema: type: string description: | Search for a product keyword, with the default search scope in `Product Name`, and additionally based on the flags from the request in `SKU` and `Description`. nullable: true - name: CategoryId in: query description: | Category Id schema: type: integer description: | Category Id nullable: true - name: MinPrice in: query description: '' schema: type: integer description: '' nullable: true - name: MaxPrice in: query description: '' schema: type: integer description: '' nullable: true - name: SearchOnlyFeaturedProducts in: query description: '' required: true schema: type: boolean description: '' - name: SearchInDescription in: query description: '' required: true schema: type: boolean description: '' - name: SearchInSKU in: query description: '' required: true schema: type: boolean description: '' - name: SearchIncludePublished in: query description: | When set to `true`, this will exclusively return products with the `Published` flag. required: true schema: type: boolean description: | When set to `true`, this will exclusively return products with the `Published` flag. - name: TwoLetterLanguageIsoCode in: query description: | Perform a product search within the scope of a specific language. schema: type: string description: | Perform a product search within the scope of a specific language. nullable: true - name: ProductTag in: query description: | If this is set, the query will exclusively return products that contain this tag. schema: type: string description: | If this is set, the query will exclusively return products that contain this tag. nullable: true - name: PageIndex in: query description: | The page index should begin from 0. required: true schema: type: integer description: | The page index should begin from 0. - name: PageSize in: query description: | The page index should begin from 0. required: true schema: type: integer description: | The page index should begin from 0. - name: Order in: query description: '' required: true schema: enum: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity type: string description: '' x-enum-descriptions: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity x-ms-enum: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity x-enumNames: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity x-enum-varnames: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity responses: '200': description: Products that meet the specified search criteria. content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoProductInfo' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoProductInfo' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/products/searchbysku: description: No documentation get: tags: - Catalog summary: Search products by sku description: '' parameters: - name: SKU in: query description: '' schema: type: string description: '' nullable: true - name: IncludeAttributeCombination in: query description: | A flag that indicates whether to order based on attribute combinations or not. required: true schema: type: boolean description: | A flag that indicates whether to order based on attribute combinations or not. - name: RequireExactMatch in: query description: | If enabled, this will execute an exact search; otherwise, it will perform a partial match. required: true schema: type: boolean description: | If enabled, this will execute an exact search; otherwise, it will perform a partial match. - name: PageIndex in: query description: | Page Index, should start from 0 required: true schema: type: integer description: | Page Index, should start from 0 - name: PageSize in: query description: | Page size required: true schema: type: integer description: | Page size - name: Order in: query description: '' required: true schema: enum: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity type: string description: '' x-enum-descriptions: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity x-ms-enum: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity x-enumNames: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity x-enum-varnames: - Position - Name - Price - CreatedOn - Sku - Published - Id - ProductType - VariantName - Group - StockQuantity responses: '200': description: Products that meet the specified search criteria. content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoProductInfo' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoProductInfo' description: '' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/product/stockbysku: description: No documentation post: tags: - Catalog summary: Update stock by sku description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateStockBySkuRequest' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateStockBySkuRequest' responses: '200': description: Update response content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateStockBySkuResponseModel' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateStockBySkuResponseModel' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/v2/product: description: This operation returns a list of all products available within the system. get: tags: - Catalog V2 summary: Get products description: This operation returns a list of all products available within the system. parameters: - name: CategoryId in: query description: '' schema: type: integer description: '' nullable: true - name: ThumbnailSize in: query description: '' schema: type: integer description: '' nullable: true - name: PreviewSize in: query description: '' schema: type: integer description: '' nullable: true - name: Published in: query description: '' schema: type: boolean description: '' nullable: true - name: PageIndex in: query description: '' required: true schema: type: integer description: '' - name: PerPage in: query description: '' required: true schema: type: integer description: '' responses: '200': description: Successfully retrieved products content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoProductInfoV2' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoProductInfoV2' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/catalog/v2/product/{id}': description: Get detailed information for a product within the system get: tags: - Catalog V2 summary: Product details description: Get detailed information for a product within the system parameters: - name: id in: path description: | Product id required: true schema: type: integer description: '' - name: thumbnailSize in: query description: | Optional width of the thumbnail image schema: type: integer description: '' nullable: true - name: previewSize in: query description: | Optional width of the preview image schema: type: integer description: '' nullable: true responses: '200': description: Product details content: application/json: schema: $ref: '#/components/schemas/InfigoProductInfo' application/xml: schema: $ref: '#/components/schemas/InfigoProductInfo' '404': description: No product was found by supplied product id content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/v2/product/create: description: No documentation post: tags: - Catalog V2 summary: Create a product description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoCreateProductRequestV2' application/xml: schema: $ref: '#/components/schemas/InfigoCreateProductRequestV2' responses: '200': description: 'The product was successfully created, and the product ID will be provided in the response.' content: application/json: schema: $ref: '#/components/schemas/InfigoCreateProductInfoV2' application/xml: schema: $ref: '#/components/schemas/InfigoCreateProductInfoV2' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/catalog/v2/product/update/{id}': description: No documentation put: tags: - Catalog V2 summary: Update a product description: '' parameters: - name: id in: path description: '' required: true schema: type: integer description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateProductRequestV2' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateProductRequestV2' responses: '200': description: 'The product was successfully update, and the product ID will be provided in the response.' content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateProductInfoV2' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateProductInfoV2' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' post: tags: - Catalog V2 summary: Update a product description: '' parameters: - name: id in: path description: '' required: true schema: type: integer description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateProductRequestV2' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateProductRequestV2' responses: '200': description: 'The product was successfully update, and the product ID will be provided in the response.' content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateProductInfoV2' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateProductInfoV2' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /customer/migrate: description: 'Migrates all data (basket, saved projects, images) for a specific user A (usually a guest) to another existing user B.' post: tags: - Customer summary: Migrate customer data description: 'Migrates all data (basket, saved projects, images) for a specific user A (usually a guest) to another existing user B.' parameters: - name: fromCustomer in: query description: | The user identifier (Guid) of the source user required: true schema: type: string description: '' format: uuid - name: toCustomer in: query description: | The user identifier (Guid) of the target user required: true schema: type: string description: '' format: uuid responses: '204': description: Indicates the successful migration of customer data. '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/customer/{id}': description: This operation retrieves detailed information about a customer based on the provided Customer identifier. get: tags: - Customer summary: Retrieve a customer description: This operation retrieves detailed information about a customer based on the provided Customer identifier. parameters: - name: id in: path description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. required: true schema: type: string description: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiCustomer' application/xml: schema: $ref: '#/components/schemas/InfigoApiCustomer' '404': description: Indicates that the requested customer could not be found in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /customer/: description: 'This operation updates an existing Customer record, and if the Customer doesn''t already exist, it creates a new Customer record.' post: tags: - Customer summary: Create or update a customer description: 'This operation updates an existing Customer record, and if the Customer doesn''t already exist, it creates a new Customer record.' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiCustomer' application/xml: schema: $ref: '#/components/schemas/InfigoApiCustomer' responses: '200': description: Indicates that the customer record has been successfully created or updated. content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' get: tags: - Customer summary: Customer list description: Returns a list of customers in whole the system responses: '200': description: Customer ids content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/customer/delete/{customerId}': description: Delete an existing Customer record post: tags: - Customer summary: Delete a customer description: Delete an existing Customer record parameters: - name: customerId in: path description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. required: true schema: type: string description: '' responses: '200': description: Indicates that the customer record has been successfully deleted. content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: Indicates that the requested customer could not be found in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/customer/updaterewardpoints/{customerId}': description: This operation allows you to update the rewards points of a customer in the system. post: tags: - Customer summary: Update reward points description: This operation allows you to update the rewards points of a customer in the system. parameters: - name: customerId in: path description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. required: true schema: type: string description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateRewardPoints' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateRewardPoints' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: This message indicates that the requested customer could not be found in the system or the Rewards points feature is disabled content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/download/{id}': description: This operation returns the download location based on the provided ID. get: tags: - Download summary: Retrieve download location description: This operation returns the download location based on the provided ID. parameters: - name: id in: path description: | Download Id (Guid) required: true schema: type: string description: '' responses: '200': description: Indicates that the requested download location could not be found in the system. Will return an `application/octet-stream` content: application/octet-stream: schema: $ref: '#/components/schemas/InfigoOctetStream' '404': description: Indicates that the requested download location could not be found in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /editor/touchjob: description: 'This endpoint is designed to mark a job as used or touched, adding the current timestamp. This action prevents the job from being cleaned up or removed immediately. It can be useful when you want to retain a job for an indefinite period.' post: tags: - Editor summary: Touch job description: 'This endpoint is designed to mark a job as used or touched, adding the current timestamp. This action prevents the job from being cleaned up or removed immediately. It can be useful when you want to retain a job for an indefinite period.' parameters: - name: id in: query description: | The orderline item identifier can take one of two values: - `Shopping Cart ID`: This represents the identifier associated with a shopping cart item. - `Job ID`: This represents the identifier associated with a job. schema: type: string description: '' nullable: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoTouchJobResponseModel' application/xml: schema: $ref: '#/components/schemas/InfigoTouchJobResponseModel' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /editor/linkfor: description: 'This function generates a link for embedding the editor into an iFrame. The generated link authenticates the user and has a short-lived validity period. You must specify the product ID, and optionally, the orderline item ID if you intend to edit an existing product (such as a basket item or saved project). Please check the Infigo Iframe integration (https://wiki-iframe.private.infigosoftware.rocks/) for more information' get: tags: - Editor summary: Link for editor description: 'This function generates a link for embedding the editor into an iFrame. The generated link authenticates the user and has a short-lived validity period. You must specify the product ID, and optionally, the orderline item ID if you intend to edit an existing product (such as a basket item or saved project). Please check the Infigo Iframe integration (https://wiki-iframe.private.infigosoftware.rocks/) for more information' parameters: - name: id in: query description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. required: true schema: type: string description: '' format: uuid - name: orderlineItemId in: query description: | When you intend to edit an existing item, such as a basket or a saved project, you must specify the item's identifier here. schema: type: string description: '' nullable: true - name: quantity in: query description: | This field represents the quantity of the item. If no value is provided, the default quantity is set to 1. schema: type: integer description: '' nullable: true - name: errorUrl in: query description: | Specify the URL for the iFrame to display in case of an authentication error. schema: type: string description: '' nullable: true - name: embeddedMode in: query description: | Use this flag to determine whether the editor should operate in embedded mode. The specific mode depends on the editor being used. If uncertain, leave unset to use the most suitable default mode. schema: type: boolean description: '' nullable: true - name: embeddedOperationMode in: query description: | Use this flag to determine whether the editor should run in embedded operation mode. The specific operation mode varies depending on the editor in use. If you're unsure, it's advisable to leave this flag unset to utilize the most suitable default mode. Note that setting `embbedOperationMode` to true is necessary for the editor ('ME') to display a save button. schema: type: boolean description: '' nullable: true - name: productSku in: query description: | Use the Product SKU when you need to target a product based on its SKU rather than its Product ID. schema: type: string description: '' nullable: true - name: productId in: query description: | The Product ID is used when no SKU is provided. It is required when neither an SKU nor an orderlineitemId is provided. schema: type: integer description: '' nullable: true responses: '200': description: This link is used to embed the editor within an iFrame content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '400': description: 'Validation failed, response will include a list of errors.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '404': description: This indicates that the product with the supplied ID or SKU or customer with the supplied ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /editor/duplicatejob: description: 'Using this operation, you can create a one-to-one clone of an existing job, and a new job ID will be provided as a result.' get: tags: - Editor summary: Duplicate Job description: 'Using this operation, you can create a one-to-one clone of an existing job, and a new job ID will be provided as a result.' parameters: - name: jobId in: query description: | The Job ID with Prefix is used to identify supported Dynamic and Infigo Products. For example, you may use the prefix **d50** to specify a Job ID. required: true schema: type: string description: '' - name: addInBasketStatus in: query description: | This flag controls whether the in-basket status should be added to the duplicated job. schema: type: boolean description: '' responses: '200': description: 'After the operation, a new Job ID will be provided as the result.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '400': description: 'Validation failed, response will include a list of errors.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '404': description: This indicates that the supplied job ID could not be located within the Infigo system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /editor/createjob: description: Creates a new job for a product using variable data from an existing MegaEdit job. The returned editor link is for the specific job created. post: tags: - Editor summary: Create Job description: Creates a new job for a product using variable data from an existing MegaEdit job. The returned editor link is for the specific job created. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiEditorLinkToRequest' application/xml: schema: $ref: '#/components/schemas/InfigoApiEditorLinkToRequest' responses: '200': description: Job created successfully. content: application/json: schema: $ref: '#/components/schemas/InfigoApiEditorResult' application/xml: schema: $ref: '#/components/schemas/InfigoApiEditorResult' '403': description: Validation error or failure in creating the job. content: application/json: schema: $ref: '#/components/schemas/InfigoApiErrorResponse' application/xml: schema: $ref: '#/components/schemas/InfigoApiErrorResponse' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /v2/editor/duplicatejob: description: 'Using this operation, you can create a one-to-one clone of an existing job, and a new job ID will be provided as a result.' post: tags: - Editor V2 summary: Duplicate Job description: 'Using this operation, you can create a one-to-one clone of an existing job, and a new job ID will be provided as a result.' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoDuplicateJobRequest' application/xml: schema: $ref: '#/components/schemas/InfigoDuplicateJobRequest' responses: '200': description: 'After the operation, a new Job ID will be provided as the result.' content: application/json: schema: $ref: '#/components/schemas/InfigoJobDuplicatedResponse' application/xml: schema: $ref: '#/components/schemas/InfigoJobDuplicatedResponse' '400': description: 'Validation failed, response will include a list of errors.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '404': description: This indicates that the supplied job ID could not be located within the Infigo system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/hotfolder/{id}': description: This operation retrieves a list of hotfolders associated with a specific Print Location ID. get: tags: - HotFolder summary: Get hotfolders by print location description: This operation retrieves a list of hotfolders associated with a specific Print Location ID. parameters: - name: id in: path description: | Print location Id required: true schema: type: string description: '' responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoHotFolder' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoHotFolder' description: '' '404': description: This signifies that there are no active hotfolders available for the requested print location. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '403': description: This message indicates that either the authentication process has failed or the provided hotfolder is not a valid integer. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /hotfolder: description: This operation retrieves a list of all active hotfolders that are marked to be visible via the API. get: tags: - HotFolder summary: Get all description: This operation retrieves a list of all active hotfolders that are marked to be visible via the API. responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoHotFolder' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoHotFolder' description: '' '404': description: This signifies that there are no active hotfolders available for the requested print location. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /infigoorderproduct/updatestatus: description: This operation allows you to update the status of an InfigoOrderProduct record by specifying its ID. post: tags: - InfigoOrderProduct summary: Update Job description: This operation allows you to update the status of an InfigoOrderProduct record by specifying its ID. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoOrderProduct' application/xml: schema: $ref: '#/components/schemas/InfigoOrderProduct' responses: '204': description: Status update successful '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/job/{id}': description: 'This will bring the next available item to the the download queue, the return will have a unique download Id.' get: tags: - Job summary: Retrieve a job description: 'This will bring the next available item to the the download queue, the return will have a unique download Id.' parameters: - name: id in: path description: | Hotfolder Id required: true schema: type: string description: '' responses: '200': description: This refers to the next job that is awaiting processing in the queue. content: application/json: schema: $ref: '#/components/schemas/InfigoJob' application/xml: schema: $ref: '#/components/schemas/InfigoJob' '404': description: Indicates that there are no active jobs currently available. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /job/: description: This operation allows you to update the status of a job. post: tags: - Job summary: Update job description: This operation allows you to update the status of a job. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoSetJobModel' application/xml: schema: $ref: '#/components/schemas/InfigoSetJobModel' responses: '200': description: Success '404': description: Indicates that the job with the specified ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /misexternalref/updateexternalid: description: This operation updates ExternalId of a MisExternalRef post: tags: - MisExternalRef summary: Update ExternalId description: This operation updates ExternalId of a MisExternalRef requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateMisExternalRefRequest' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateMisExternalRefRequest' responses: '200': description: ExternalId was updated successfully content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '400': description: Validation for provided details failed content: application/json: schema: $ref: '#/components/schemas/InfigoApiErrorModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiErrorModel' '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '/order/list/{id}': description: This operation allows you to obtain a list of order IDs associated with the specified user. get: tags: - Order summary: Retrieve customer orders description: This operation allows you to obtain a list of order IDs associated with the specified user. parameters: - name: id in: path description: | Customer guid required: true schema: type: string description: '' format: uuid - name: filterByStatus in: query description: | Order status Possible values: `10` - Open `20` - Paid `30` - Shipped `40` - Complete `50` - Cancelled `60` - Delivered schema: enum: - 10 - 20 - 30 - 40 - 50 - 60 type: string description: |+ Possible values: `10` - Open `20` - Paid `30` - Shipped `40` - Complete `50` - Cancelled `60` - Delivered nullable: true x-enum-descriptions: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-ms-enum: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-enumNames: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-enum-varnames: - Open - Paid - Shipped - Complete - Cancelled - Delivered responses: '200': description: Order ids content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '404': description: This message indicates that the customer with the provided GUID could not be located in the system. '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /order/list/: description: This operation allows you to obtain a list of order IDs. get: tags: - Order summary: Retrieve orders description: This operation allows you to obtain a list of order IDs. parameters: - name: filterByStatus in: query description: | Order status Possible values: `10` - Open `20` - Paid `30` - Shipped `40` - Complete `50` - Cancelled `60` - Delivered schema: enum: - 10 - 20 - 30 - 40 - 50 - 60 type: string description: |+ Possible values: `10` - Open `20` - Paid `30` - Shipped `40` - Complete `50` - Cancelled `60` - Delivered nullable: true x-enum-descriptions: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-ms-enum: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-enumNames: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-enum-varnames: - Open - Paid - Shipped - Complete - Cancelled - Delivered - name: orderedAfter in: query description: '' schema: type: string description: '' format: date-time nullable: true - name: orderedBefore in: query description: '' schema: type: string description: '' format: date-time nullable: true responses: '200': description: Order ids content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/order/detail/{id}': description: Retrieve order details by id get: tags: - Order summary: Retrieve a order description: Retrieve order details by id parameters: - name: id in: path description: | Order id required: true schema: type: integer description: '' responses: '200': description: Order details content: application/json: schema: $ref: '#/components/schemas/InfigoOrderItem' application/xml: schema: $ref: '#/components/schemas/InfigoOrderItem' '404': description: Indicates that the order with the provided ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/order/setpurchaseordernumber/{id}': description: This operation allows you to modify the optional purchase order number associated with a specific order ID. post: tags: - Order summary: Set PO Number description: This operation allows you to modify the optional purchase order number associated with a specific order ID. parameters: - name: id in: path description: | Order id required: true schema: type: integer description: '' - name: purchaseOrderNumber in: query description: | The new purchase order number required: true schema: type: string description: '' responses: '200': description: Indicates that order was successful updated in Infigo '404': description: Indicates that the order with the provided ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/order/settrackingnumber/{id}': description: This operation allows you to update the tracking number ID for a specific order. post: tags: - Order summary: Set tracking number description: This operation allows you to update the tracking number ID for a specific order. parameters: - name: id in: path description: | Order id required: true schema: type: integer description: '' - name: trackingNumber in: query description: | New tracking number schema: type: string description: '' nullable: true responses: '204': description: Indicates that order was successful updated in Infigo '404': description: Indicates that the order with the provided ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/order/orderstatus/{id}': description: This operation allows you to update the status of an order. post: tags: - Order summary: Change status description: This operation allows you to update the status of an order. parameters: - name: id in: path description: | Order id required: true schema: type: integer description: '' - name: newStatus in: query description: | New status of the order Possible values: `10` - Open `20` - Paid `30` - Shipped `40` - Complete `50` - Cancelled `60` - Delivered required: true schema: enum: - 10 - 20 - 30 - 40 - 50 - 60 type: string description: |+ Possible values: `10` - Open `20` - Paid `30` - Shipped `40` - Complete `50` - Cancelled `60` - Delivered x-enum-descriptions: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-ms-enum: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-enumNames: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-enum-varnames: - Open - Paid - Shipped - Complete - Cancelled - Delivered responses: '200': description: Indicates that order was successful updated in Infigo '403': description: 'Validation failed, response will include a list of errors.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '404': description: Indicates that the order with the provided ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/order/reorder/{id}': description: 'This action allows you to recreate an existing order by adding all of its items to the current basket. It does not immediately place the order. Optionally, you can specify a new customer ID for whom you want to place the order with.' post: tags: - Order summary: Reorder description: 'This action allows you to recreate an existing order by adding all of its items to the current basket. It does not immediately place the order. Optionally, you can specify a new customer ID for whom you want to place the order with.' parameters: - name: id in: path description: '' required: true schema: type: integer description: '' - name: customerId in: query description: '' schema: type: integer description: '' nullable: true responses: '200': description: This message confirms that the requested order has been successfully recreated in the basket. '400': description: Requested order cannot be reordered content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '404': description: Indicates that the order with the provided ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/order/placeorder/{id}': description: 'This action initiates the placement of a new order. All items in the current shopping basket of the user will be included in the order. Optionally, you can specify a shipping and billing address, as well as a shipping method, to be used for this order.' post: tags: - Order summary: Place order description: 'This action initiates the placement of a new order. All items in the current shopping basket of the user will be included in the order. Optionally, you can specify a shipping and billing address, as well as a shipping method, to be used for this order.' parameters: - name: id in: path description: | Customer guid required: true schema: type: string description: '' format: uuid requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoPlaceOrderHelper' application/xml: schema: $ref: '#/components/schemas/InfigoPlaceOrderHelper' responses: '200': description: This message serves as confirmation that the order has been successfully created. '403': description: This message indicates that there are no items in the basket for the requested user. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '404': description: Indicates that the requested customer could not be found in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '409': description: 'Validation failed, response will include a list of errors.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/order/invoice/{id}': description: This operation allows you to obtain the invoice for a specific order. get: tags: - Order summary: Get invoice description: This operation allows you to obtain the invoice for a specific order. parameters: - name: id in: path description: | Order id required: true schema: type: integer description: '' responses: '200': description: Invoice PDF content: application/octet-stream: schema: $ref: '#/components/schemas/InfigoOctetStream' '404': description: Indicates that the order with the provided ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/order/pdfpackagingslip/{id}': description: This operation allows you to obtain the PDF packaging slip for a specific order. post: tags: - Order summary: Get the pdf packaging slip description: This operation allows you to obtain the PDF packaging slip for a specific order. parameters: - name: id in: path description: '' required: true schema: type: integer description: '' requestBody: description: Parameter content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoKeyValuePair_2_String_String' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoKeyValuePair_2_String_String' description: '' responses: '200': description: Invoice PDF content: application/octet-stream: schema: $ref: '#/components/schemas/InfigoOctetStream' '404': description: Indicates that the order with the provided ID could not be located in the system. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /order/recordorder: description: This action initiates the process of creating and submitting a new order within the Infigo system. post: tags: - Order summary: Record order description: This action initiates the process of creating and submitting a new order within the Infigo system. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiRecordOrder' application/xml: schema: $ref: '#/components/schemas/InfigoApiRecordOrder' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /order/preorder: description: 'This endpoint pre-validates the object used to place an API order via the ''RecordOrder'' endpoint. It ensures that the order can be successfully placed. If validation fails, the response will include a list of errors that need to be resolved before placing the order on the ''RecordOrder'' API endpoint.' post: tags: - Order summary: Pre-Place Order Validation description: 'This endpoint pre-validates the object used to place an API order via the ''RecordOrder'' endpoint. It ensures that the order can be successfully placed. If validation fails, the response will include a list of errors that need to be resolved before placing the order on the ''RecordOrder'' API endpoint.' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiRecordOrder' application/xml: schema: $ref: '#/components/schemas/InfigoApiRecordOrder' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/basketitems/{id}': description: This operation allows you to obtain a list of order line item IDs that the specified user currently has in their basket. get: tags: - OrderlineItem summary: Retrieve basket list description: This operation allows you to obtain a list of order line item IDs that the specified user currently has in their basket. parameters: - name: id in: path description: | Customer Guid required: true schema: type: string description: '' format: uuid responses: '200': description: Basket items ids content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '400': description: The provided Customer Guid format is incorrect. Please ensure you provide a valid Guid. content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '404': description: This message indicates that the customer with the provided GUID could not be located in the system. '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/savedprojects/{id}': description: This operation allows you to retrieve a list of order line item IDs that the specified user has saved for future editing. get: tags: - OrderlineItem summary: Retrieve saved project list description: This operation allows you to retrieve a list of order line item IDs that the specified user has saved for future editing. parameters: - name: id in: path description: | Customer Guid required: true schema: type: string description: '' format: uuid responses: '200': description: Basket items ids content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '400': description: The provided Customer Guid format is incorrect. Please ensure you provide a valid Guid. content: application/json: schema: type: array items: type: integer description: '' description: '' application/xml: schema: type: array items: type: integer description: '' description: '' '404': description: This message indicates that the customer with the provided GUID could not be located in the system. '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/reorder/{id}': description: This action duplicates an existing order line item and adds it to the current basket. It does not automatically place an order. post: tags: - OrderlineItem summary: Reorder orderline description: This action duplicates an existing order line item and adds it to the current basket. It does not automatically place an order. parameters: - name: id in: path description: | Order line item id. required: true schema: type: string description: '' responses: '200': description: Indicates that the order has been successfully added to the basket. '400': description: 'Validation failed, response will include a list of errors.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/searchbynotes/{notes}': description: 'This operation allows you to search for order line items based on their associated notes. The search can be performed as either an exact match (default) or a contains match, depending on the specified criteria.' get: tags: - OrderlineItem summary: Search by notes description: 'This operation allows you to search for order line items based on their associated notes. The search can be performed as either an exact match (default) or a contains match, depending on the specified criteria.' parameters: - name: notes in: path description: | Search notes required: true schema: type: string description: '' - name: exact in: query description: | If enabled, this will execute an exact search; otherwise, it will perform a partial match. required: true schema: type: boolean description: '' default: 'True' responses: '200': description: These are the order line items that meet the specified criteria. content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoOrderlineItem' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoOrderlineItem' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/createoutputfor/{id}': description: This action is used to generate output for a specific job. post: tags: - OrderlineItem summary: Create output description: This action is used to generate output for a specific job. parameters: - name: id in: path description: | The Job ID with Prefix is used to identify supported Dynamic and Infigo Products. For example, you may use the prefix **d50** to specify a Job ID. required: true schema: type: string description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoOutputCreationRequest' application/xml: schema: $ref: '#/components/schemas/InfigoOutputCreationRequest' responses: '200': description: Indicates that the output has been successfully created '404': description: 'If the reference provided in the request is not found, the response should contain a detailed error message.' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/get/{id}': description: This operation allows you to obtain specific details for a particular order line item. get: tags: - OrderlineItem summary: Retrieve orderline item description: This operation allows you to obtain specific details for a particular order line item. parameters: - name: id in: path description: | This identifier refers to either a job or a shopping cart item. required: true schema: type: string description: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoOrderlineItem' application/xml: schema: $ref: '#/components/schemas/InfigoOrderlineItem' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/delete/{id}': description: This action deletes the specified order line item. Please note that only items that have not been ordered yet can be deleted. post: tags: - OrderlineItem summary: Delete a order line description: This action deletes the specified order line item. Please note that only items that have not been ordered yet can be deleted. parameters: - name: id in: path description: | This identifier refers to either a job or a shopping cart item. required: true schema: type: string description: '' responses: '200': description: Indicates that the orderline item was deleted successfully '404': description: Orderline by provided id was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' delete: tags: - OrderlineItem summary: Delete a order line description: This action deletes the specified order line item. Please note that only items that have not been ordered yet can be deleted. parameters: - name: id in: path description: | This identifier refers to either a job or a shopping cart item. required: true schema: type: string description: '' responses: '200': description: Indicates that the orderline item was deleted successfully '404': description: Orderline by provided id was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/updatecartitem/{id}': description: This action allows you to modify the quantity of a specific order line item. Please note that this is only valid if the item has not been ordered yet. Setting the quantity to 0 will result in the item's deletion. post: tags: - OrderlineItem summary: Update cart item description: This action allows you to modify the quantity of a specific order line item. Please note that this is only valid if the item has not been ordered yet. Setting the quantity to 0 will result in the item's deletion. parameters: - name: id in: path description: | Shopping cart item id required: true schema: type: string description: '' - name: quantity in: query description: | New quantity required: true schema: type: integer description: '' responses: '200': description: Indicates that the orderline item was deleted successfully '404': description: Orderline by provided id was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/updateitemstatus/{id}': description: This action allows you to assign a new status to an order line item. Please note that this operation is only possible once the order line item has been ordered. post: tags: - OrderlineItem summary: Update job status description: This action allows you to assign a new status to an order line item. Please note that this operation is only possible once the order line item has been ordered. parameters: - name: id in: path description: | Job id required: true schema: type: string description: '' - name: newStatus in: query description: | New status to use for this order line item Possible values: `8` - Printed `9` - Shipped `11` - AwaitingData `12` - AwaitingParts `13` - AwaitingProof `14` - InArtworking `15` - InFinishing `16` - InPacking `17` - InProduction `18` - InReprographics `19` - OnHold `26` - OutputVerified `46` - ReadyForCollection `49` - Blocked `51` - MisOrderProcessed `52` - MisAssetsOk `53` - MisAssetsFailed `73` - Cancelled required: true schema: enum: - 8 - 9 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 26 - 46 - 49 - 51 - 52 - 53 - 73 type: string description: |+ Possible values: `8` - Printed `9` - Shipped `11` - AwaitingData `12` - AwaitingParts `13` - AwaitingProof `14` - InArtworking `15` - InFinishing `16` - InPacking `17` - InProduction `18` - InReprographics `19` - OnHold `26` - OutputVerified `46` - ReadyForCollection `49` - Blocked `51` - MisOrderProcessed `52` - MisAssetsOk `53` - MisAssetsFailed `73` - Cancelled x-enum-descriptions: - Printed - Shipped - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - OutputVerified - ReadyForCollection - Blocked - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - Cancelled x-ms-enum: - Printed - Shipped - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - OutputVerified - ReadyForCollection - Blocked - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - Cancelled x-enumNames: - Printed - Shipped - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - OutputVerified - ReadyForCollection - Blocked - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - Cancelled x-enum-varnames: - Printed - Shipped - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - OutputVerified - ReadyForCollection - Blocked - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - Cancelled responses: '200': description: Indicates that the orderline item was deleted successfully '404': description: Orderline by provided id was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /orderlineitem/v2/notes/: description: This action allows you to assign a new status to an order line item. Please note that this operation is only possible once the order line item has been ordered. put: tags: - OrderlineItem summary: Update order line item note description: This action allows you to assign a new status to an order line item. Please note that this operation is only possible once the order line item has been ordered. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateNotesRequest' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateNotesRequest' responses: '204': description: Indicates that the orderline item was updated successfully '404': description: Orderline by provided id was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /OrderlineItemController/UpdateItemNotes: description: This action allows you to assign a new status to an order line item. Please note that this operation is only possible once the order line item has been ordered. post: tags: - OrderlineItem summary: Update item notes description: This action allows you to assign a new status to an order line item. Please note that this operation is only possible once the order line item has been ordered. parameters: - name: id in: query description: '' schema: type: string description: '' nullable: true requestBody: description: '' content: text/plain: schema: type: string responses: '200': description: Indicates that the orderline item was updated successfully '404': description: Orderline by provided id was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' deprecated: true /orderlineitem/listorderlineitemids/: description: This operation retrieves a list of all order line items located in the specified print location. get: tags: - OrderlineItem summary: Orderlines at print location description: This operation retrieves a list of all order line items located in the specified print location. parameters: - name: itemType in: query description: | Possible values: `10` - Normal `20` - Variable `30` - Static `40` - MultiPart `50` - Dynamic `70` - Symphony required: true schema: enum: - 10 - 20 - 30 - 40 - 50 - 70 type: string description: |+ Possible values: `10` - Normal `20` - Variable `30` - Static `40` - MultiPart `50` - Dynamic `70` - Symphony x-enum-descriptions: - Normal - Variable - Static - MultiPart - Dynamic - Symphony x-ms-enum: - Normal - Variable - Static - MultiPart - Dynamic - Symphony x-enumNames: - Normal - Variable - Static - MultiPart - Dynamic - Symphony x-enum-varnames: - Normal - Variable - Static - MultiPart - Dynamic - Symphony responses: '200': description: Job ids content: application/json: schema: type: array items: type: string description: '' nullable: true description: '' application/xml: schema: type: array items: type: string description: '' nullable: true description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/jobticket/{id}': description: This operation allows you to obtain the ticket associated with a specific job. get: tags: - OrderlineItem summary: Get job ticket description: This operation allows you to obtain the ticket associated with a specific job. parameters: - name: id in: path description: | Job id required: true schema: type: string description: '' responses: '200': description: Job ticket PDF content: application/octet-stream: schema: $ref: '#/components/schemas/InfigoOctetStream' '404': description: Orderline by provided id was not found content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/download/{id}': description: This operation enables you to download the output generated for a specific job. get: tags: - OrderlineItem summary: Download output description: This operation enables you to download the output generated for a specific job. parameters: - name: id in: path description: | Job id required: true schema: type: string description: '' responses: '200': description: Download Output PDF content: application/octet-stream: schema: $ref: '#/components/schemas/InfigoOctetStream' '404': description: Orderline by provided id was not found content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/updateoutput/{id}': description: This operation allows you to update the output for a specific job. post: tags: - OrderlineItem summary: Download output description: This operation allows you to update the output for a specific job. parameters: - name: id in: path description: | Job id required: true schema: type: string description: '' requestBody: description: '' content: multipart/form-data: schema: required: - File type: object properties: File: type: string format: binary responses: '200': description: Output was updated content: application/octet-stream: schema: $ref: '#/components/schemas/InfigoOctetStream' '400': description: The output update failed '404': description: Orderline by provided id was not found content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '406': description: Request is not properly formatted '415': description: Provide file if not of pdf type '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/orderlineitem/deleteitemstatus/{itemId}': description: This action is used to delete a requested job status associated with a job. post: tags: - OrderlineItem summary: Delete job status description: This action is used to delete a requested job status associated with a job. parameters: - name: itemId in: path description: | Job id required: true schema: type: string description: '' - name: statusId in: query description: | Job status to delete Possible values: `0` - Nothing `1` - Creating `2` - InBasket `3` - Ordered `4` - OutputCreationStarted `5` - OutputCreated `6` - OutputCreationFailed `7` - InHotFolder `8` - Printed `9` - Shipped `10` - AwaitingApproval `11` - AwaitingData `12` - AwaitingParts `13` - AwaitingProof `14` - InArtworking `15` - InFinishing `16` - InPacking `17` - InProduction `18` - InReprographics `19` - OnHold `20` - FutureOrder `21` - UnapprovedOrder `22` - Rejected `23` - Approved `24` - RecreationRequested `25` - OutputDownloaded `26` - OutputVerified `27` - SentEmail `28` - SentEmailFailed `29` - SmsDispatched `30` - EmailBounced `31` - EmailBouncedAndPrintJobCreated `32` - PrintJobVersion `33` - NoEmailBounceActionRequired `34` - SmsDispatching `35` - MisNotified `36` - MisFailed `37` - TemplateProductCreated `38` - TemplateProductCreationFailed `39` - ExternalOutputRequested `40` - ExternalOutputJobClosed `41` - ActionRun `42` - MisNotificationRetrigger `43` - CustomStatus `44` - CustomStatusHidden `45` - MisAdditionalActionRequired `46` - ReadyForCollection `47` - MisManifested `48` - CopyToHotFolderFailed `49` - Blocked `50` - ArtworkUploaded `51` - CopyToHotFolderSkipped `52` - MisOrderProcessed `53` - MisAssetsOk `54` - MisAssetsFailed `55` - PartiallyApproved `56` - JobDataDeleted `57` - ValidationFailed `58` - ValidationFinished `59` - MisPartiallyFailed `60` - ApprovalJobUpdated `61` - OutputDelete `62` - MisShipped `63` - MisSkipped `64` - AwaitingFinalize `65` - ShippedQuantity `66` - MisCustomStatus `67` - Cancelled `68` - JobTicketDownloaded `69` - JobTicketVerified `70` - StatusManuallyRemoved required: true schema: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 type: string description: |+ Possible values: `0` - Nothing `1` - Creating `2` - InBasket `3` - Ordered `4` - OutputCreationStarted `5` - OutputCreated `6` - OutputCreationFailed `7` - InHotFolder `8` - Printed `9` - Shipped `10` - AwaitingApproval `11` - AwaitingData `12` - AwaitingParts `13` - AwaitingProof `14` - InArtworking `15` - InFinishing `16` - InPacking `17` - InProduction `18` - InReprographics `19` - OnHold `20` - FutureOrder `21` - UnapprovedOrder `22` - Rejected `23` - Approved `24` - RecreationRequested `25` - OutputDownloaded `26` - OutputVerified `27` - SentEmail `28` - SentEmailFailed `29` - SmsDispatched `30` - EmailBounced `31` - EmailBouncedAndPrintJobCreated `32` - PrintJobVersion `33` - NoEmailBounceActionRequired `34` - SmsDispatching `35` - MisNotified `36` - MisFailed `37` - TemplateProductCreated `38` - TemplateProductCreationFailed `39` - ExternalOutputRequested `40` - ExternalOutputJobClosed `41` - ActionRun `42` - MisNotificationRetrigger `43` - CustomStatus `44` - CustomStatusHidden `45` - MisAdditionalActionRequired `46` - ReadyForCollection `47` - MisManifested `48` - CopyToHotFolderFailed `49` - Blocked `50` - ArtworkUploaded `51` - CopyToHotFolderSkipped `52` - MisOrderProcessed `53` - MisAssetsOk `54` - MisAssetsFailed `55` - PartiallyApproved `56` - JobDataDeleted `57` - ValidationFailed `58` - ValidationFinished `59` - MisPartiallyFailed `60` - ApprovalJobUpdated `61` - OutputDelete `62` - MisShipped `63` - MisSkipped `64` - AwaitingFinalize `65` - ShippedQuantity `66` - MisCustomStatus `67` - Cancelled `68` - JobTicketDownloaded `69` - JobTicketVerified `70` - StatusManuallyRemoved x-enum-descriptions: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - MisFailed - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - ReadyForCollection - MisManifested - CopyToHotFolderFailed - Blocked - ArtworkUploaded - CopyToHotFolderSkipped - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - MisPartiallyFailed - ApprovalJobUpdated - OutputDelete - MisShipped - MisSkipped - AwaitingFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-ms-enum: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - MisFailed - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - ReadyForCollection - MisManifested - CopyToHotFolderFailed - Blocked - ArtworkUploaded - CopyToHotFolderSkipped - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - MisPartiallyFailed - ApprovalJobUpdated - OutputDelete - MisShipped - MisSkipped - AwaitingFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-enumNames: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - MisFailed - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - ReadyForCollection - MisManifested - CopyToHotFolderFailed - Blocked - ArtworkUploaded - CopyToHotFolderSkipped - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - MisPartiallyFailed - ApprovalJobUpdated - OutputDelete - MisShipped - MisSkipped - AwaitingFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-enum-varnames: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - MisFailed - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - ReadyForCollection - MisManifested - CopyToHotFolderFailed - Blocked - ArtworkUploaded - CopyToHotFolderSkipped - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - MisPartiallyFailed - ApprovalJobUpdated - OutputDelete - MisShipped - MisSkipped - AwaitingFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved responses: '200': description: Job status deleted with success '400': description: 'Validation failed, response will include a list of errors.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '404': description: Orderline by provided id was not found content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/printlocation/{id}': description: No documentation get: tags: - PrintLocation summary: Retrieve print location description: '' parameters: - name: id in: path description: | Print location name required: true schema: type: string description: '' responses: '200': description: Print location content: application/json: schema: $ref: '#/components/schemas/InfigoPrintLocation' application/xml: schema: $ref: '#/components/schemas/InfigoPrintLocation' '404': description: No active print location with requested id was found content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /printlocation/get: description: No documentation get: tags: - PrintLocation summary: Retrieve all print locations description: '' responses: '200': description: Print locations content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoPrintLocation' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoPrintLocation' description: '' '404': description: This will return the list of print locations based on your account. API Auth Token is required. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /printlocation: description: No documentation get: tags: - PrintLocation summary: Retrieve all print locations description: '' responses: '200': description: Print locations content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoPrintLocation' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoPrintLocation' description: '' '404': description: This will return the list of print locations based on your account. API Auth Token is required. content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /catalog/groups: description: This operation returns a list of all product groups paginated available within the system. get: tags: - ProductGroup summary: Get product groups paginated description: This operation returns a list of all product groups paginated available within the system. parameters: - name: PageIndex in: query description: '' required: true schema: type: integer description: '' - name: PerPage in: query description: '' required: true schema: type: integer description: '' responses: '200': description: Successfully retrieved product groups content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoApiProductGroupInfo' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoApiProductGroupInfo' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' post: tags: - ProductGroup summary: Create product group description: Created a new product group with provided details. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoCreateProductGroupRequest' application/xml: schema: $ref: '#/components/schemas/InfigoCreateProductGroupRequest' responses: '200': description: Product group was created successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: Validation for provided details failed content: application/json: schema: $ref: '#/components/schemas/InfigoApiErrorModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiErrorModel' '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '/catalog/groups/{id}': description: This operation retrieves detailed information about a group and it's details. get: tags: - ProductGroup summary: Get product group description: This operation retrieves detailed information about a group and it's details. parameters: - name: id in: path description: '' required: true schema: type: integer description: '' responses: '200': description: Details about product group retrieved successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiProductGroupInfo' application/xml: schema: $ref: '#/components/schemas/InfigoApiProductGroupInfo' '404': description: Product group with provided identifier was not found '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' post: tags: - ProductGroup summary: Update product group description: Update a existing product group with the provided identifier. parameters: - name: id in: path description: '' required: true schema: type: integer description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateProductGroupRequest' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateProductGroupRequest' responses: '200': description: Product group was updated successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: Validation for provided details failed content: application/json: schema: $ref: '#/components/schemas/InfigoApiErrorModel' application/xml: schema: $ref: '#/components/schemas/InfigoApiErrorModel' '404': description: Product group with provided identifier was not found '409': description: Concurrency conflict while updating the product group. Please try again. '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string /quote/create: description: This action allows the creation of a quote on behalf of a customer for a valid product. The generated quote can be used as a reference for future orders. post: tags: - Quote summary: Create a quote description: This action allows the creation of a quote on behalf of a customer for a valid product. The generated quote can be used as a reference for future orders. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiQuoteCreate' application/xml: schema: $ref: '#/components/schemas/InfigoApiQuoteCreate' responses: '200': description: Quote created successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /quote/update: description: This action is used to update an existing quote for a customer. post: tags: - Quote summary: Update a quote description: This action is used to update an existing quote for a customer. requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiQuoteEdit' application/xml: schema: $ref: '#/components/schemas/InfigoApiQuoteEdit' responses: '200': description: Quote created successfully content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/quote/{quoteId}': description: No documentation get: tags: - Quote summary: Retrieve a quote description: '' parameters: - name: quoteId in: path description: '' required: true schema: type: integer description: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiGetQuote' application/xml: schema: $ref: '#/components/schemas/InfigoApiGetQuote' '400': description: Quote with supplied Id was not found content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/quote/{quoteId}/delete': description: No documentation post: tags: - Quote summary: Delete an quote description: '' parameters: - name: quoteId in: path description: '' required: true schema: type: integer description: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /quote/bycustomer: description: 'This operation allows you to retrieve a list of quote IDs attached to a customer. Note: pagination is not supported' get: tags: - Quote summary: Retrieve a list of quotes description: 'This operation allows you to retrieve a list of quote IDs attached to a customer. Note: pagination is not supported' parameters: - name: customerId in: query description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. required: true schema: type: string description: '' - name: isHiddenInclude in: query description: | This option controls whether hidden quotes should be included in the returned list of quote representations. required: true schema: type: boolean description: '' responses: '200': description: Additional params `CatfishQuoteIds` will be included in response which will be a list of quote Ids content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: Customer with the supplied Id was not found content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/ssocookie/{id}': description: 'Returns cookie ticket based on Email address passed in. It will also create a new user in the system if it doesnt exist. The cookie name is also passed along. If the cookie name is not passed, the AppHarbor security plug-in is used. **use SSOCookie endpoint instead**' get: tags: - SSOCookie summary: Retrieve authentication cookie description: 'Returns cookie ticket based on Email address passed in. It will also create a new user in the system if it doesnt exist. The cookie name is also passed along. If the cookie name is not passed, the AppHarbor security plug-in is used. **use SSOCookie endpoint instead**' parameters: - name: id in: path description: '' required: true schema: type: string description: '' responses: '200': description: The system has successfully generated a token based on the provided information. content: application/json: schema: $ref: '#/components/schemas/InfigoApiCustomerToken' application/xml: schema: $ref: '#/components/schemas/InfigoApiCustomerToken' '404': description: 'This situation occurs when registration is prohibited in the system, and the attempt to find an existing customer fails.' content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/ssourl/{id}': description: 'Returns an individual URL to login a user. It will create the user if required and returns the login URL which will automatically login the user into Infigo. Additionally, it will return the cookie ticket and a creation flag.' get: tags: - SSOUrl summary: Get SSO Url description: 'Returns an individual URL to login a user. It will create the user if required and returns the login URL which will automatically login the user into Infigo. Additionally, it will return the cookie ticket and a creation flag.' parameters: - name: id in: path description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. required: true schema: type: string description: '' - name: returnUrl in: query description: | The URL the user should be redirected to after successful authorization. Can be null to return to the home page schema: type: string description: '' nullable: true - name: errorUrl in: query description: | The URL the user should be redirected to after a failed authorization. Can be null to return to the home page schema: type: string description: '' nullable: true - name: logoutUrl in: query description: | The URL the user should be redirected to after logout. Requires 'LogoutUrl' customer additional attribute. If null, the user will only be logged out from Infigo without redirection. schema: type: string description: '' nullable: true responses: '200': description: Successfully retrieved customer SSO content: application/json: schema: $ref: '#/components/schemas/InfigoApiCustomerSsoResult' application/xml: schema: $ref: '#/components/schemas/InfigoApiCustomerSsoResult' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/storagefolder/{id}': description: Will return the first type of a storage folder found. API Auth Token is required. get: tags: - StorageFolder summary: Retrieve a storage folder description: Will return the first type of a storage folder found. API Auth Token is required. parameters: - name: id in: path description: | Type of storage folder required: true schema: type: string description: '' responses: '200': description: Returns storage folder details content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: No storage folder was found by provided id content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /storefront: description: No documentation get: tags: - Storefront summary: Retrieve all storefronts description: | **Available only for platform API Tokens** responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/InfigoGetStorefrontAdminModel' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/InfigoGetStorefrontAdminModel' description: '' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' post: tags: - Storefront summary: Create storefront description: | **Available only for platform API Tokens** requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoCreateStorefrontModel' application/xml: schema: $ref: '#/components/schemas/InfigoCreateStorefrontModel' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoCreateStorefrontModelResult' application/xml: schema: $ref: '#/components/schemas/InfigoCreateStorefrontModelResult' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/storefront/{identifier}': description: No documentation get: tags: - Storefront summary: Retrieve storefront description: | **Available only for platform API Tokens** parameters: - name: identifier in: path description: | Storefront Id or Name required: true schema: type: string description: '' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InfigoGetStorefrontAdminModel' application/xml: schema: $ref: '#/components/schemas/InfigoGetStorefrontAdminModel' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' put: tags: - Storefront summary: Update a storefront description: | **Available only for platform API Tokens** parameters: - name: identifier in: path description: | Storefront Id or Name required: true schema: type: string description: '' requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoUpdateStorefrontModel' application/xml: schema: $ref: '#/components/schemas/InfigoUpdateStorefrontModel' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: Storefront by supplied identifier was not found. content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' delete: tags: - Storefront summary: Delete a storefront description: | **Available only for platform API Tokens** parameters: - name: identifier in: path description: | Storefront Id or Name required: true schema: type: string description: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: Storefront by supplied identifier was not found. content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/storefront/{identifier}/token': description: No documentation post: tags: - Storefront summary: Create API Token description: | **Available only for platform API Tokens** parameters: - name: identifier in: path description: | Storefront Id or Name required: true schema: type: string description: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoApiAuthenticationTokenModelResult' application/xml: schema: $ref: '#/components/schemas/InfigoApiAuthenticationTokenModelResult' '400': description: 'Validation failed, response will include a list of errors.' content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '404': description: Storefront by supplied identifier was not found. content: application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /storefront/current: description: No documentation get: tags: - Storefront summary: Get Api Token context storefront description: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoGetStorefrontModel' application/xml: schema: $ref: '#/components/schemas/InfigoGetStorefrontModel' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /storefront/current/scss: description: No documentation post: tags: - Storefront summary: Add new css file to override existing editor styles. description: '' requestBody: description: '' content: multipart/form-data: schema: required: - File type: object properties: File: type: string format: binary responses: '204': description: CSS uploaded with success '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' get: tags: - Storefront summary: Gets the SCSS Template used to customize the editor description: '' responses: '200': description: Scss content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /storefront/current/setup: description: Get the basic setup of the storefront get: tags: - Storefront summary: Get storefront setup description: Get the basic setup of the storefront responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoStorefrontSetupModel' application/xml: schema: $ref: '#/components/schemas/InfigoStorefrontSetupModel' '500': description: Internal server error '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string /thumbnail/generate: description: |- ### POST /Thumbnail/Generate #### Summary - **Operation**: Generate a Thumbnail - **HTTP Method**: POST - **Tags**: Thumbnail Generation #### Request Body - **Format**: application/json - **Content**: - `Customer`: Optional customer identifier. Either customer ID, GUID, or email/username. A new guest user will be created if nothing provided. - `Product`: Product Identifier (SKU or Infigo Product ID). - `ProductAttributes`: A list of name/value pairs for product attributes. The attributes must be attached to the product. For attributes with preselected value, if nothing is provided to the API, the default value will be selected. - `Key`: The attribute name. - `Value`: The attribute value. - `VariableItems`: A list of variable set name/variable item name/value pairs. - `VariableSetName`: The name of the variable set. - `VariableItemName`: The name of the variable item. - `Value`: The value of the variable item. - `NotificationUrl`: Optional postback URL when the operation is complete. Either 200 or 403 in case something went wrong in the process of creating the thumbnail. An error message will come along with the request. #### Example Request ```json { "Customer": "customer123", "Product": "SKU12345", "ProductAttributes": [ { "Key": "Color", "Value": "Red" } ], "VariableItems": [ { "VariableSetName": "Variable set name here", "VariableItemName": "Text", "Value": "Sample text" }, { "VariableSetName": "Variable set name here", "VariableItemName": "RichText", "Value": "Sample rich text" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Boolean", "Value": "true" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Number", "Value": "123" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Date", "Value": "2024-05-20" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Time", "Value": "12:34:56" }, { "VariableSetName": "Variable set name here", "VariableItemName": "List", "Value": "["item1", "item2"]" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Color", "Value": "#FFFFFF" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Image as URL", "Value": "https://example.com/image.jpg" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Image from an existing album. In case of multiple albums or media with the same name, the first will always be picked.}", "Value": "{ \"AlbumName\": \"Default\", \"AlbumMedia\": \"mediaName.jpg\}" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Image as base64. Convert images to base64 and set it as value.}", "Value": "data:image/png;base64,HereIsTheDataString" } ], "NotificationUrl": "https://example.com/notify" } post: tags: - Thumbnail summary: Generate thumbnail description: |- ### POST /Thumbnail/Generate #### Summary - **Operation**: Generate a Thumbnail - **HTTP Method**: POST - **Tags**: Thumbnail Generation #### Request Body - **Format**: application/json - **Content**: - `Customer`: Optional customer identifier. Either customer ID, GUID, or email/username. A new guest user will be created if nothing provided. - `Product`: Product Identifier (SKU or Infigo Product ID). - `ProductAttributes`: A list of name/value pairs for product attributes. The attributes must be attached to the product. For attributes with preselected value, if nothing is provided to the API, the default value will be selected. - `Key`: The attribute name. - `Value`: The attribute value. - `VariableItems`: A list of variable set name/variable item name/value pairs. - `VariableSetName`: The name of the variable set. - `VariableItemName`: The name of the variable item. - `Value`: The value of the variable item. - `NotificationUrl`: Optional postback URL when the operation is complete. Either 200 or 403 in case something went wrong in the process of creating the thumbnail. An error message will come along with the request. #### Example Request ```json { "Customer": "customer123", "Product": "SKU12345", "ProductAttributes": [ { "Key": "Color", "Value": "Red" } ], "VariableItems": [ { "VariableSetName": "Variable set name here", "VariableItemName": "Text", "Value": "Sample text" }, { "VariableSetName": "Variable set name here", "VariableItemName": "RichText", "Value": "Sample rich text" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Boolean", "Value": "true" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Number", "Value": "123" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Date", "Value": "2024-05-20" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Time", "Value": "12:34:56" }, { "VariableSetName": "Variable set name here", "VariableItemName": "List", "Value": "["item1", "item2"]" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Color", "Value": "#FFFFFF" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Image as URL", "Value": "https://example.com/image.jpg" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Image from an existing album. In case of multiple albums or media with the same name, the first will always be picked.}", "Value": "{ \"AlbumName\": \"Default\", \"AlbumMedia\": \"mediaName.jpg\}" }, { "VariableSetName": "Variable set name here", "VariableItemName": "Image as base64. Convert images to base64 and set it as value.}", "Value": "data:image/png;base64,HereIsTheDataString" } ], "NotificationUrl": "https://example.com/notify" } requestBody: description: Parameter content: application/json: schema: $ref: '#/components/schemas/InfigoApiThumbnailRequest' application/xml: schema: $ref: '#/components/schemas/InfigoApiThumbnailRequest' responses: '200': description: |- #### Successful Response (200) - **Description**: A response that includes the thumbnail URL that will be available after the thumbnail is generated. ApiResult will include the request details. In case a new customer is being created, its GUID will be returned in the CustomerGuid field. Thumbnail URL will return 404 until the thumbnail is generated. If notification URL was set, a message will be sent once the image is available at that URL. #### Example Response ```json { "Success": true, "ContextInfo": { "ErrorList": [] }, "ApiResult": { "CustomerGuid": "5db34416-0687-4a71-8a19-ff1a55205096", "JobId": "d123", "EditLink": "{{StoreUrl}}/{{StorefrontName}}/CF/DynamicProduct/StartEditor/1?orderProductId=12", "ThumbnailLink": "{{StoreUrl}}/{{StorefrontName}}/CF/FileCache/Get/1cd51455-f078-4f0b-ade3-4b82c870f614?name=Dynamic%20with%20Variables", "Details": { "ProductId": "1234", "ProductSku": "ProductSku", "ProductAttributes": { "Key": "Value" }, "Variables": [ { "VariableSetName": "Variable set name", "VariableItemName": "Variable item name", "Value": "value" } ] }, "ActionId": "ed3e783b-c652-4adc-9bbd-e476cddf6cee" } } content: application/json: schema: $ref: '#/components/schemas/InfigoApiThumbnailResponse' application/xml: schema: $ref: '#/components/schemas/InfigoApiThumbnailResponse' '403': description: A success flag that will be false in case of any validation errors. ContextInfo object contains a list of validation errors. content: application/json: schema: $ref: '#/components/schemas/InfigoApiThumbnailResponse' application/xml: schema: $ref: '#/components/schemas/InfigoApiThumbnailResponse' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/thumbnail/getstatus/{actionId}': description: Gets the status of a thumbnail generation action. The actionId parameter is required to identify the specific action. get: tags: - Thumbnail summary: '[Deprecated, please use the method from Action sections] Get status of thumbnail' description: Gets the status of a thumbnail generation action. The actionId parameter is required to identify the specific action. parameters: - name: actionId in: path description: '' required: true schema: type: string description: '' format: uuid responses: '200': description: Record found successfully and details about it content: application/json: schema: $ref: '#/components/schemas/InfigoImmediateActionRecordDisplayModel' application/xml: schema: $ref: '#/components/schemas/InfigoImmediateActionRecordDisplayModel' '404': description: Action with provided it not found content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' deprecated: true '/uploadcsv/{id}': description: Uploads a CSV file as a MultipartFormDataStream for the specified user. post: tags: - UploadCSV summary: Upload csv file description: Uploads a CSV file as a MultipartFormDataStream for the specified user. parameters: - name: id in: path description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. required: true schema: type: string description: '' - name: type in: query description: | Possible values: `0` - UsedInEditor `1` - BatchUpload schema: enum: - 0 - 1 type: string description: |+ Possible values: `0` - UsedInEditor `1` - BatchUpload nullable: true x-enum-descriptions: - UsedInEditor - BatchUpload x-ms-enum: - UsedInEditor - BatchUpload x-enumNames: - UsedInEditor - BatchUpload x-enum-varnames: - UsedInEditor - BatchUpload responses: '406': description: Please ensure that provided file is of type CSV '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' '/uploadlocation/{id}': description: Returns details about a upload location based on the name that has been passed in. get: tags: - UploadLocation summary: Retrieve an upload location description: Returns details about a upload location based on the name that has been passed in. parameters: - name: id in: path description: | Name of the upload location required: true schema: type: string description: '' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoUploadLocation' application/xml: schema: $ref: '#/components/schemas/InfigoUploadLocation' '404': description: Upload location by supplied name was not found content: text/plain: schema: type: string description: '' nullable: true application/json: schema: type: string description: '' nullable: true '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' post: tags: - UploadLocation summary: Uploads a document description: Uploads a document as a MultipartFormDataStream to the specified upload location. parameters: - name: id in: path description: | Id of the upload location required: true schema: type: string description: '' requestBody: description: '' content: multipart/form-data: schema: required: - File type: object properties: File: type: string format: binary responses: '200': description: Document uploaded successfully '404': description: No upload location found with the provided id '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /uploadlocation/: description: Returns details about all upload locations. get: tags: - UploadLocation summary: Retrieve a list description: Returns details about all upload locations. responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoUploadLocation' application/xml: schema: $ref: '#/components/schemas/InfigoUploadLocation' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' /uploadlocation/get: description: Returns details about all upload locations. get: tags: - UploadLocation summary: Retrieve a list description: Returns details about all upload locations. responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InfigoUploadLocation' application/xml: schema: $ref: '#/components/schemas/InfigoUploadLocation' '401': description: Authorization details are invalid. content: text/plain: schema: type: string '403': description: Authorization details are invalid. content: text/plain: schema: type: string '500': description: Internal server error content: text/plain: schema: type: string description: '' nullable: true application/json: schema: $ref: '#/components/schemas/InfigoApiResponseObject' application/xml: schema: $ref: '#/components/schemas/InfigoApiResponseObject' components: schemas: Authorization: title: Authorization type: string description: | ## Authentication and Security ### Overview To ensure secure access to Infigo's endpoints, an API Token is required for authentication. Follow these steps to obtain and use the API Token: ### Requesting an API Token 1. Start by raising a support ticket with our dedicated Support Desk. [Create a ticket here](https://infigosoftware.zendesk.com/hc/en-us/requests/new). 2. In your support ticket, kindly request the creation of a new API Token specifically for your designated storefront. 3. Our support team will promptly generate the requested API Token and provide it to you. ### Using the API Token Our API relies on basic authentication for enhanced security. When using tools like Postman to test API requests, follow these steps to include the API Token: 1. If you haven't already, download and install [Postman](https://infigosoftware.zendesk.com/hc/en-us/articles/360048785512). 2. Access the Authorization tab within Postman. 3. Set the Authorization Type to **Basic Auth.** 4. Paste the API Token provided into the username field. Example Authorization Header: `Authorization: Basic YTFiYTAwMjEtMTRiZi00YWNmLThkYTQtNzVmYTVjMDllMjdi` This API Token will grant you access to our endpoints securely, ensuring the protection of your data and interactions. InfigoApiCustomerToken: type: object properties: CookieName: type: string description: '' nullable: true Token: type: string description: '' nullable: true description: '' InfigoIApiError: type: object properties: ErrorMessage: type: string description: '' nullable: true Location: type: string description: '' nullable: true IsBadRequest: type: boolean description: '' description: '' InfigoContextInfo: type: object properties: ErrorList: type: array items: $ref: '#/components/schemas/InfigoIApiError' description: '' description: '' InfigoApiResponseObject: type: object properties: Success: type: boolean description: '' Code: type: string description: '' nullable: true ContextInfo: $ref: '#/components/schemas/InfigoContextInfo' HelpUrl: type: string description: '' nullable: true Message: type: string description: '' nullable: true description: '' InfigoImmediateActionRecordDisplayModel: type: object properties: Status: type: string description: '' nullable: true Progress: type: integer description: '' CreatedOnUtc: type: string description: '' format: date-time description: '' InfigoApiNotFoundError: type: object properties: ErrorMessage: type: string description: '' nullable: true Location: type: string description: '' nullable: true IsBadRequest: type: boolean description: '' description: '' InfigoApiAddressBookModel: type: object properties: Id: type: integer description: '' nullable: true Name: type: string description: '' nullable: true Description: type: string description: '' nullable: true ValidateRecords: type: boolean description: '' AvailableForEveryone: type: boolean description: '' description: '' InfigoObject: type: object description: '' InfigoError: type: object properties: PropertyName: type: string description: '' nullable: true ErrorMessage: type: string description: '' nullable: true AttemptedValue: $ref: '#/components/schemas/InfigoObject' description: '' InfigoApiErrorModel: type: object properties: Message: type: string description: '' nullable: true Errors: type: array items: $ref: '#/components/schemas/InfigoError' description: '' description: '' InfigoAssignAddressBookModel: type: object properties: Id: type: integer description: '' AddressBook: $ref: '#/components/schemas/InfigoApiAddressBookModel' AssignAddressBookTo: enum: - 0 - 1 - 2 type: string description: |+ Possible values: `0` - Customer `1` - Department `2` - CustomerRole x-enum-descriptions: - Customer - Department - CustomerRole x-ms-enum: - Customer - Department - CustomerRole x-enumNames: - Customer - Department - CustomerRole x-enum-varnames: - Customer - Department - CustomerRole description: '' InfigoApiMisConfig: type: object properties: PluginSystemName: type: string description: '' nullable: true ExternalId: type: string description: '' nullable: true description: '' InfigoApiAddress: type: object properties: Id: type: integer description: '' nullable: true FirstName: type: string description: '' nullable: true LastName: type: string description: '' nullable: true CompanyName: type: string description: '' nullable: true AddressLine1: type: string description: '' nullable: true AddressLine2: type: string description: '' nullable: true Town: type: string description: '' nullable: true ZipPostalCode: type: string description: '' nullable: true StateProvince: type: string description: '' nullable: true Country: type: string description: '' nullable: true Telephone: type: string description: '' nullable: true FaxNumber: type: string description: '' nullable: true Email: type: string description: '' nullable: true IsUsableAsShippingAddress: type: boolean description: '' nullable: true IsUsableAsBillingAddress: type: boolean description: '' nullable: true IsEditableName: type: boolean description: '' nullable: true IsEditableAddress: type: boolean description: '' nullable: true IsEditableCompany: type: boolean description: '' nullable: true IsEditableContact: type: boolean description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. description: '' InfigoAssignApiAddressModel: type: object properties: Id: type: integer description: '' Address: $ref: '#/components/schemas/InfigoApiAddress' AssignAddressTo: enum: - 0 - 1 - 2 type: string description: |+ Possible values: `0` - Customer `1` - Department `2` - AddressBook x-enum-descriptions: - Customer - Department - AddressBook x-ms-enum: - Customer - Department - AddressBook x-enumNames: - Customer - Department - AddressBook x-enum-varnames: - Customer - Department - AddressBook description: '' InfigoAuthentication: type: object properties: Name: type: string description: '' nullable: true Id: type: integer description: '' ApiKey: type: string description: '' nullable: true AccountId: type: integer description: '' PortalId: type: integer description: '' description: '' InfigoBatchJobItemInfo: type: object properties: JobId: type: integer description: '' Status: enum: - 5 - 10 - 15 type: string description: |+ Possible values: `5` - Pending `10` - Failed `15` - Finished x-enum-descriptions: - Pending - Failed - Finished x-ms-enum: - Pending - Failed - Finished x-enumNames: - Pending - Failed - Finished x-enum-varnames: - Pending - Failed - Finished ErrorMessage: type: string description: '' nullable: true description: '' InfigoBatchJobItemsInfoModel: type: object properties: BatchJobItems: type: array items: $ref: '#/components/schemas/InfigoBatchJobItemInfo' description: '' ErrorMessage: type: string description: '' nullable: true description: '' InfigoJob: type: object properties: BatchJobItemStatus: type: string description: '' nullable: true Type: type: string description: '' nullable: true PayLoad: type: array properties: data: type: object description: '' ErrorMessage: type: string description: '' nullable: true description: '' InfigoBatchJobCallbackModel: type: object properties: BatchId: type: string description: '' nullable: true Status: type: string description: '' nullable: true ErrorMessage: type: string description: '' nullable: true Jobs: type: array items: $ref: '#/components/schemas/InfigoJob' description: '' description: '' InfigoApiBatchJobsModel: type: object properties: CallbackUrl: type: string description: '' nullable: true IncludeJobsData: type: boolean description: '' nullable: true Jobs: type: array items: $ref: '#/components/schemas/InfigoJob' description: '' description: '' InfigoCapabilityResponse: type: object properties: SettingName: type: string description: '' nullable: true SettingValue: type: string description: '' nullable: true description: '' InfigoMisCapabilityModel: type: object properties: PluginName: type: string description: | Plugin name nullable: true SettingName: type: string description: | Setting name nullable: true description: | Context model to pass for MisPlugin category InfigoCheckStatusCapabilityRequest: type: object properties: Category: enum: - 0 type: string description: |+ Category type Possible values: `0` - MisPlugin x-enum-descriptions: - MisPlugin x-ms-enum: - MisPlugin x-enumNames: - MisPlugin x-enum-varnames: - MisPlugin Context: type: array oneOf: - $ref: '#/components/schemas/InfigoMisCapabilityModel' properties: data: type: object description: '' description: '' InfigoCreateCategoryRequest: type: object properties: Name: type: string description: | Category Name Description: type: string description: | Category Description nullable: true ParentCategoryId: type: integer description: | Category Parent Id nullable: true description: '' InfigoProductSpecificationAttributeInfo: type: object properties: Id: type: integer description: '' AttributeName: type: string description: '' nullable: true AttributeOption: type: string description: '' nullable: true description: '' InfigoProductAttributeValueInfo: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true FriendlyName: type: string description: '' nullable: true HtmlInfo: type: string description: '' nullable: true DisplayOrder: type: integer description: '' IsPreSelected: type: boolean description: '' IsDisabled: type: boolean description: '' PriceAdjustment: type: integer description: '' PriceAdjustmentType: type: string description: '' nullable: true WeightAdjustment: type: integer description: '' LengthAdjustment: type: integer description: '' nullable: true WidthAdjustment: type: integer description: '' nullable: true HeightAdjustment: type: integer description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoProductAttributeInfo: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true Description: type: string description: '' nullable: true AttributeControlType: enum: - 1 - 2 - 3 - 4 - 10 - 20 - 30 - 40 - 50 - 60 - 70 - 999 type: integer description: |+ Possible values: `1` - DropdownList `2` - RadioList `3` - Checkboxes `4` - TextBox `10` - MultilineTextbox `20` - Datepicker `30` - FileUpload `40` - Info `50` - HtmlSchema `60` - System `70` - Number `999` - Hidden x-enum-descriptions: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-ms-enum: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-enumNames: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-enum-varnames: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden IsRequired: type: boolean description: '' ProductAttributeValues: type: array items: $ref: '#/components/schemas/InfigoProductAttributeValueInfo' description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoProductAttributeCombination: type: object properties: Id: type: integer description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeInfo' description: '' AllowOutOfStockOrders: enum: - 0 - 1 - 2 type: string description: |+ Possible values: `0` - NoBackorders `1` - AllowQtyBelow0 `2` - AllowQtyBelow0AndNotifyCustomer x-enum-descriptions: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-ms-enum: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-enumNames: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-enum-varnames: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer Sku: type: string description: '' nullable: true Priority: type: integer description: '' StockValue: type: integer description: '' MinimumBasketQuantity: type: integer description: '' nullable: true MaximumBasketQuantity: type: integer description: '' nullable: true Published: type: boolean description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoProductInfo: type: object properties: ShortDescription: type: string description: '' nullable: true SpecificationAttributes: type: array items: $ref: '#/components/schemas/InfigoProductSpecificationAttributeInfo' description: '' Id: type: integer description: '' Name: type: string description: '' nullable: true LongDescription: type: string description: '' nullable: true Type: enum: - 10 - 20 - 30 - 40 - 50 - 60 - 70 - 80 type: integer description: |+ Possible values: `10` - Normal `20` - Variable `30` - Static `40` - MultiPart `50` - Dynamic `60` - Sms `70` - Symphony `80` - Custom x-enum-descriptions: - Normal - Variable - Static - MultiPart - Dynamic - Sms - Symphony - Custom x-ms-enum: - Normal - Variable - Static - MultiPart - Dynamic - Sms - Symphony - Custom x-enumNames: - Normal - Variable - Static - MultiPart - Dynamic - Sms - Symphony - Custom x-enum-varnames: - Normal - Variable - Static - MultiPart - Dynamic - Sms - Symphony - Custom Price: type: integer description: '' StockValue: type: integer description: '' Sku: type: string description: '' nullable: true OrderPackQuantity: type: integer description: '' QuantitySelectorMode: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Units `1` - Packs x-enum-descriptions: - Units - Packs x-ms-enum: - Units - Packs x-enumNames: - Units - Packs x-enum-varnames: - Units - Packs PreviewUrls: type: array items: type: string description: '' nullable: true description: '' ThumbnailUrls: type: array items: type: string description: '' nullable: true description: '' Tags: type: array items: type: string description: '' nullable: true description: '' IsShippingEnabled: type: boolean description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeInfo' description: '' AttributeCombinations: type: array items: $ref: '#/components/schemas/InfigoProductAttributeCombination' description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. description: '' InfigoApiBaseTierPrice: type: object properties: Quantity: type: integer description: '' Price: type: integer description: '' description: '' InfigoProductAttributeValueRequest: type: object properties: Name: type: string description: | The name of the product attribute value. nullable: true FriendlyName: type: string description: | A user-friendly name for the product attribute value. nullable: true HtmlInfo: type: string description: | HTML content providing additional information about the product attribute value. nullable: true DisplayOrder: type: integer description: | The display order of the product attribute value in the UI. IsDisabled: type: boolean description: | Indicates whether the product attribute value is disabled and should not be available for selection. IsPreselected: type: boolean description: | Indicates whether the product attribute value is selected by default. ProductionOffsetAdjustment: type: integer description: | The adjustment to the product's production time when this value is selected. PriceAdjustment: type: integer description: | The price adjustment applied to the product's base price when this value is selected. WeightAdjustment: type: integer description: | The weight adjustment applied to the product when this value is selected. WidthAdjustment: type: integer description: | The adjustment applied to the product's width when this value is selected. HeightAdjustment: type: integer description: | The adjustment applied to the product's height when this value is selected. LengthAdjustment: type: integer description: | The adjustment applied to the product's length when this value is selected. PriceAdjustmentType: enum: - 0 - 1 type: string description: |+ The type of price adjustment applied, indicating whether it's an absolute value or a percentage. Possible values: `0` - Percent `1` - Absolute x-enum-descriptions: - Percent - Absolute x-ms-enum: - Percent - Absolute x-enumNames: - Percent - Absolute x-enum-varnames: - Percent - Absolute description: '' InfigoProductAttributeRequest: type: object properties: ProductAttributeValues: type: array items: $ref: '#/components/schemas/InfigoProductAttributeValueRequest' description: | A list of product attribute values to assign to product attribute. An empty list will delete the assigned attributes values. MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. Id: type: integer description: | The ID of the product attribute you want to assign to the product. nullable: true Name: type: string description: | The name of the product attribute. Not mandatory if ID provided nullable: true ProductPageLabel: type: string description: | The label of the product attribute that will be displayed on the product page. Please use "Description" instead of ProductPageLabel(obsolete) to pass the value nullable: true IsRequired: type: boolean description: | Indicates whether the product attribute is required. DisplayOrder: type: integer description: | The display order of the product attribute in the UI. IsHidden: type: boolean description: | Indicates whether the product attribute is hidden from the UI. AttributeControlType: enum: - 1 - 2 - 3 - 4 - 10 - 20 - 30 - 40 - 50 - 60 - 70 - 999 type: string description: |+ Possible values: `1` - DropdownList `2` - RadioList `3` - Checkboxes `4` - TextBox `10` - MultilineTextbox `20` - Datepicker `30` - FileUpload `40` - Info `50` - HtmlSchema `60` - System `70` - Number `999` - Hidden x-enum-descriptions: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-ms-enum: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-enumNames: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-enum-varnames: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden description: '' InfigoCreateProductRequest: type: object properties: TierPrices: type: array items: $ref: '#/components/schemas/InfigoApiBaseTierPrice' description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeRequest' description: | A list of product attribute to assign to product. An empty list will delete the assigned attributes values. IsShippingEnabled: type: boolean description: '' CreateFromProductId: type: integer description: | If a value is provided, the product properties will be copied from the requested product. nullable: true MinimumBasketQuantity: type: integer description: '' nullable: true DefaultBasketQuantity: type: integer description: '' nullable: true MaximumBasketQuantity: type: integer description: '' nullable: true OrderPackQuantity: type: integer description: '' nullable: true Price: type: integer description: '' QuantitySelectorMode: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Units `1` - Packs nullable: true x-enum-descriptions: - Units - Packs x-ms-enum: - Units - Packs x-enumNames: - Units - Packs x-enum-varnames: - Units - Packs Name: type: string description: '' Description: type: string description: '' nullable: true FullDescription: type: string description: '' nullable: true Tags: type: array items: type: string description: '' nullable: true description: '' CategoryIds: type: array items: type: integer description: '' description: '' ProductGroupId: type: integer description: | Link the product to a product group. nullable: true SKU: type: string description: '' nullable: true description: '' InfigoUpdateProductRequest: type: object properties: ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeRequest' description: '' ProductId: type: integer description: '' Price: type: integer description: '' nullable: true IsShippingEnabled: type: boolean description: '' Name: type: string description: '' Description: type: string description: '' nullable: true FullDescription: type: string description: '' nullable: true Tags: type: array items: type: string description: '' nullable: true description: '' CategoryIds: type: array items: type: integer description: '' description: '' ProductGroupId: type: integer description: | Link the product to a product group. nullable: true SKU: type: string description: '' nullable: true description: '' InfigoUpdateStockQuantityResultModel: type: object properties: Success: type: boolean description: '' ContextInfo: $ref: '#/components/schemas/InfigoContextInfo' description: '' InfigoUpdateStockAttribute: type: object properties: Key: type: string description: | Attribute name nullable: true Value: type: string description: | Attribute value nullable: true description: '' InfigoUpdateStockQuantityModel: type: object properties: ProductId: type: integer description: | ProductId StockValue: type: integer description: | Stock value IsAbsoluteAdjustment: type: boolean description: | If is set to `true`, it will be set to this value. If set to `false`, it will subtract or append. Attributes: type: array items: $ref: '#/components/schemas/InfigoUpdateStockAttribute' description: | If the product is configured to manage stock by attribute combination, this set will specify which attribute combination to set. description: '' InfigoCategoryInfo: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true Description: type: string description: '' nullable: true ThumbnailUrl: type: string description: '' nullable: true PreviewUrl: type: string description: '' nullable: true ProductIds: type: array items: type: integer description: '' description: '' SubCategoryIds: type: array items: type: integer description: '' description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. description: '' InfigoProductTemplateSyncInfo: type: object properties: CategoryId: type: integer description: '' CategoryName: type: string description: '' nullable: true ProductId: type: integer description: | Infigo product id ProductName: type: string description: '' nullable: true ProductType: type: string description: | The letter identifier for the product type. nullable: true Timestamp: type: string description: '' format: date-time Sha256Hash: type: string description: '' nullable: true MessageSentUtc: type: string description: '' format: date-time description: '' InfigoUpdateStockQuantityResultSkuItemModel: type: object properties: Id: type: integer description: '' Type: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Product `1` - ProductAttributeCombination x-enum-descriptions: - Product - ProductAttributeCombination x-ms-enum: - Product - ProductAttributeCombination x-enumNames: - Product - ProductAttributeCombination x-enum-varnames: - Product - ProductAttributeCombination SKU: type: string description: '' nullable: true OldStockValue: type: integer description: '' NewStockValue: type: integer description: '' description: '' InfigoUpdateStockBySkuResponseModel: type: object properties: Success: type: boolean description: '' ContextInfo: $ref: '#/components/schemas/InfigoContextInfo' UpdatedItems: type: array items: $ref: '#/components/schemas/InfigoUpdateStockQuantityResultSkuItemModel' description: '' description: '' InfigoUpdateStockBySkuRequest: type: object properties: SKU: type: string description: '' nullable: true IncludeAttributeCombination: type: boolean description: '' RequireExactMatch: type: boolean description: '' StockValue: type: integer description: '' IsAbsoluteAdjustment: type: boolean description: '' description: '' InfigoApiTierPrice: type: object properties: Quantity: type: integer description: | The quantity for the tier price Price: type: integer description: | The price for the given quantity Role: type: string description: | The role to apply tier price for. Do not provide it at all to assign it to everyone or use role system name to assign to a specific role nullable: true description: '' InfigoProductSpecificationAttributeInfoV2: type: object properties: Id: type: integer description: '' nullable: true AttributeName: type: string description: '' nullable: true AttributeOption: type: string description: '' nullable: true ShowOnProductPage: type: boolean description: '' HideFromCustomer: type: boolean description: '' DisplayOrder: type: integer description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoProductInfoV2: type: object properties: Description: type: string description: '' nullable: true AdminComment: type: string description: '' nullable: true CategoryIds: type: array items: type: integer description: '' description: '' Published: type: boolean description: '' AvailableStartDateTimeUtc: type: string description: '' format: date-time nullable: true AvailableEndDateTimeUtc: type: string description: '' format: date-time nullable: true SkipProductDetails: type: boolean description: '' DefaultBasketQuantity: type: integer description: '' MinimumBasketQuantity: type: integer description: '' MaximumBasketQuantity: type: integer description: '' HasQuantityBasedPricing: type: boolean description: '' ShowOrderlineTotal: type: boolean description: '' TierPrices: type: array items: $ref: '#/components/schemas/InfigoApiTierPrice' description: '' ProductGroupId: type: integer description: '' nullable: true SpecificationAttributes: type: array items: $ref: '#/components/schemas/InfigoProductSpecificationAttributeInfoV2' description: '' Id: type: integer description: '' Name: type: string description: '' nullable: true LongDescription: type: string description: '' nullable: true Type: enum: - 10 - 20 - 30 - 40 - 50 - 60 - 70 - 80 type: integer description: |+ Possible values: `10` - Normal `20` - Variable `30` - Static `40` - MultiPart `50` - Dynamic `60` - Sms `70` - Symphony `80` - Custom x-enum-descriptions: - Normal - Variable - Static - MultiPart - Dynamic - Sms - Symphony - Custom x-ms-enum: - Normal - Variable - Static - MultiPart - Dynamic - Sms - Symphony - Custom x-enumNames: - Normal - Variable - Static - MultiPart - Dynamic - Sms - Symphony - Custom x-enum-varnames: - Normal - Variable - Static - MultiPart - Dynamic - Sms - Symphony - Custom Price: type: integer description: '' StockValue: type: integer description: '' Sku: type: string description: '' nullable: true OrderPackQuantity: type: integer description: '' QuantitySelectorMode: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Units `1` - Packs x-enum-descriptions: - Units - Packs x-ms-enum: - Units - Packs x-enumNames: - Units - Packs x-enum-varnames: - Units - Packs PreviewUrls: type: array items: type: string description: '' nullable: true description: '' ThumbnailUrls: type: array items: type: string description: '' nullable: true description: '' Tags: type: array items: type: string description: '' nullable: true description: '' IsShippingEnabled: type: boolean description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeInfo' description: '' AttributeCombinations: type: array items: $ref: '#/components/schemas/InfigoProductAttributeCombination' description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. description: '' InfigoCreateProductInfoV2: type: object properties: Id: type: integer description: '' description: '' InfigoSpecificationAttributeRequest: type: object properties: Id: type: integer description: '' nullable: true AttributeName: type: string description: '' nullable: true AttributeOption: type: string description: '' nullable: true ShowOnProductPage: type: boolean description: '' HideFromCustomer: type: boolean description: '' DisplayOrder: type: integer description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. description: '' InfigoProductAttributeValueRequestV2: type: object properties: MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' Name: type: string description: | The name of the product attribute value. nullable: true FriendlyName: type: string description: | A user-friendly name for the product attribute value. nullable: true HtmlInfo: type: string description: | HTML content providing additional information about the product attribute value. nullable: true DisplayOrder: type: integer description: | The display order of the product attribute value in the UI. IsDisabled: type: boolean description: | Indicates whether the product attribute value is disabled and should not be available for selection. IsPreselected: type: boolean description: | Indicates whether the product attribute value is selected by default. ProductionOffsetAdjustment: type: integer description: | The adjustment to the product's production time when this value is selected. PriceAdjustment: type: integer description: | The price adjustment applied to the product's base price when this value is selected. WeightAdjustment: type: integer description: | The weight adjustment applied to the product when this value is selected. WidthAdjustment: type: integer description: | The adjustment applied to the product's width when this value is selected. HeightAdjustment: type: integer description: | The adjustment applied to the product's height when this value is selected. LengthAdjustment: type: integer description: | The adjustment applied to the product's length when this value is selected. PriceAdjustmentType: enum: - 0 - 1 type: string description: |+ The type of price adjustment applied, indicating whether it's an absolute value or a percentage. Possible values: `0` - Percent `1` - Absolute x-enum-descriptions: - Percent - Absolute x-ms-enum: - Percent - Absolute x-enumNames: - Percent - Absolute x-enum-varnames: - Percent - Absolute description: '' InfigoProductAttributeRequestV2: type: object properties: ProductAttributeValues: type: array items: $ref: '#/components/schemas/InfigoProductAttributeValueRequestV2' description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' Id: type: integer description: | The ID of the product attribute you want to assign to the product. nullable: true Name: type: string description: | The name of the product attribute. Not mandatory if ID provided nullable: true ProductPageLabel: type: string description: | The label of the product attribute that will be displayed on the product page. Please use "Description" instead of ProductPageLabel(obsolete) to pass the value nullable: true IsRequired: type: boolean description: | Indicates whether the product attribute is required. DisplayOrder: type: integer description: | The display order of the product attribute in the UI. IsHidden: type: boolean description: | Indicates whether the product attribute is hidden from the UI. AttributeControlType: enum: - 1 - 2 - 3 - 4 - 10 - 20 - 30 - 40 - 50 - 60 - 70 - 999 type: string description: |+ Possible values: `1` - DropdownList `2` - RadioList `3` - Checkboxes `4` - TextBox `10` - MultilineTextbox `20` - Datepicker `30` - FileUpload `40` - Info `50` - HtmlSchema `60` - System `70` - Number `999` - Hidden x-enum-descriptions: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-ms-enum: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-enumNames: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-enum-varnames: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden description: '' InfigoAttributeCombinationItem: type: object properties: ProductAttributeId: type: integer description: | The ID of the product attribute that is assigned to the group ProductAttributeValue: type: string description: | The value for the specified attribute. Should be an existing one, otherwise it will fail. nullable: true description: '' InfigoProductAttributeCombinationRequest: type: object properties: AttributeCombinationItems: type: array items: $ref: '#/components/schemas/InfigoAttributeCombinationItem' description: | A list of attribute combinations to assign to the product group. On update, an empty list will unassign them all from the group. Also, combinations that are assigned to the product but not provided in the update list will be unassigned. StockQuantity: type: integer description: | Indicates the stock for the combination AllowOutOfStockOrders: enum: - 0 - 1 - 2 type: string description: |+ Indicates whether customers are allowed to place out of stock orders Possible values: `0` - NoBackorders `1` - AllowQtyBelow0 `2` - AllowQtyBelow0AndNotifyCustomer x-enum-descriptions: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-ms-enum: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-enumNames: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-enum-varnames: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer MinimumBasketQuantity: type: integer description: | Indicates the minimum quantity an order can be placed for this combination nullable: true MaximumBasketQuantity: type: integer description: | Indicates the maximum quantity an order can be placed for this combination nullable: true Sku: type: string description: | Indicates the SKU for this combination nullable: true Priority: type: integer description: | Indicates the priority of the combination Published: type: boolean description: | Indicates whether this combination will be published MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. description: '' InfigoCreateProductRequestV2: type: object properties: Published: type: boolean description: '' nullable: true AvailableStartDateTimeUtc: type: string description: '' format: date-time nullable: true AvailableEndDateTimeUtc: type: string description: '' format: date-time nullable: true SkipProductDetails: type: boolean description: '' HasQuantityBasedPricing: type: boolean description: '' ShowOrderlineTotal: type: boolean description: '' AdminComment: type: string description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' SpecificationAttributes: type: array items: $ref: '#/components/schemas/InfigoSpecificationAttributeRequest' description: '' TierPrices: type: array items: $ref: '#/components/schemas/InfigoApiTierPrice' description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeRequestV2' description: '' AttributeCombinations: type: array items: $ref: '#/components/schemas/InfigoProductAttributeCombinationRequest' description: '' IsShippingEnabled: type: boolean description: '' CreateFromProductId: type: integer description: | If a value is provided, the product properties will be copied from the requested product. nullable: true MinimumBasketQuantity: type: integer description: '' nullable: true DefaultBasketQuantity: type: integer description: '' nullable: true MaximumBasketQuantity: type: integer description: '' nullable: true OrderPackQuantity: type: integer description: '' nullable: true Price: type: integer description: '' QuantitySelectorMode: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Units `1` - Packs nullable: true x-enum-descriptions: - Units - Packs x-ms-enum: - Units - Packs x-enumNames: - Units - Packs x-enum-varnames: - Units - Packs Name: type: string description: '' Description: type: string description: '' nullable: true FullDescription: type: string description: '' nullable: true Tags: type: array items: type: string description: '' nullable: true description: '' CategoryIds: type: array items: type: integer description: '' description: '' ProductGroupId: type: integer description: | Link the product to a product group. nullable: true SKU: type: string description: '' nullable: true description: '' InfigoUpdateProductInfoV2: type: object properties: Id: type: integer description: '' description: '' InfigoUpdateProductRequestV2: type: object properties: AdminComment: type: string description: '' nullable: true Published: type: boolean description: '' nullable: true AvailableStartDateTimeUtc: type: string description: '' format: date-time nullable: true AvailableEndDateTimeUtc: type: string description: '' format: date-time nullable: true SkipProductDetails: type: boolean description: '' HasQuantityBasedPricing: type: boolean description: '' ShowOrderlineTotal: type: boolean description: '' MinimumBasketQuantity: type: integer description: '' nullable: true DefaultBasketQuantity: type: integer description: '' nullable: true MaximumBasketQuantity: type: integer description: '' nullable: true OrderPackQuantity: type: integer description: '' nullable: true QuantitySelectorMode: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Units `1` - Packs nullable: true x-enum-descriptions: - Units - Packs x-ms-enum: - Units - Packs x-enumNames: - Units - Packs x-enum-varnames: - Units - Packs MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' SpecificationAttributes: type: array items: $ref: '#/components/schemas/InfigoSpecificationAttributeRequest' description: '' TierPrices: type: array items: $ref: '#/components/schemas/InfigoApiTierPrice' description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeRequestV2' description: '' AttributeCombinations: type: array items: $ref: '#/components/schemas/InfigoProductAttributeCombinationRequest' description: '' ProductId: type: integer description: '' Price: type: integer description: '' nullable: true IsShippingEnabled: type: boolean description: '' Name: type: string description: '' Description: type: string description: '' nullable: true FullDescription: type: string description: '' nullable: true Tags: type: array items: type: string description: '' nullable: true description: '' CategoryIds: type: array items: type: integer description: '' description: '' ProductGroupId: type: integer description: | Link the product to a product group. nullable: true SKU: type: string description: '' nullable: true description: '' InfigoApiCustomerAttribute: type: object properties: Key: type: string description: '' nullable: true Value: type: string description: '' nullable: true description: '' InfigoApiCustomer: type: object properties: Id: type: integer description: '' nullable: true Guid: type: string description: '' format: uuid nullable: true Username: type: string description: '' nullable: true Email: type: string description: '' nullable: true Password: type: string description: '' nullable: true Active: type: boolean description: '' nullable: true Title: type: string description: '' nullable: true Gender: type: string description: '' nullable: true FullName: type: string description: '' nullable: true FirstName: type: string description: '' nullable: true LastName: type: string description: '' nullable: true DateOfBirth: type: string description: '' format: date-time nullable: true Custom1: type: string description: '' nullable: true Custom2: type: string description: '' nullable: true Custom3: type: string description: '' nullable: true IsAdmin: type: boolean description: '' CustomerRoles: type: array items: type: string description: '' nullable: true description: '' Department: type: string description: '' nullable: true TimeZoneId: type: string description: '' nullable: true IsTaxExempt: type: boolean description: '' nullable: true AffiliateId: type: integer description: '' nullable: true PrintLocationId: type: string description: '' nullable: true PrintLocationName: type: string description: '' nullable: true AdditionalAttributes: type: array items: $ref: '#/components/schemas/InfigoApiCustomerAttribute' description: '' PromotionCardNumber: type: string description: '' nullable: true PromotionCardPoints: type: integer description: '' nullable: true VatNumber: type: string description: '' nullable: true VatNumberStatus: type: integer description: '' nullable: true CompanyName: type: string description: '' nullable: true AddressLine1: type: string description: '' nullable: true AddressLine2: type: string description: '' nullable: true City: type: string description: '' nullable: true ZipPostalCode: type: string description: '' nullable: true StateProvince: type: string description: '' nullable: true Country: type: string description: '' nullable: true Phone: type: string description: '' nullable: true Fax: type: string description: '' nullable: true BillingAddress: $ref: '#/components/schemas/InfigoApiAddress' ShippingAddress: $ref: '#/components/schemas/InfigoApiAddress' WorkflowTrustLevelEnabled: type: boolean description: '' nullable: true WorkflowTrustLevel: type: integer description: '' nullable: true Approvers: type: array items: type: string description: '' nullable: true description: '' BudgetManagers: type: array items: type: string description: '' nullable: true description: '' AdminContent: type: string description: '' nullable: true CreatedOn: type: string description: '' format: date-time nullable: true LastActivityDate: type: string description: '' format: date-time nullable: true LastIpAddress: type: string description: '' nullable: true LastVisitedPage: type: string description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. LoginMessage: type: string description: '' nullable: true ApplyDefaultStyling: type: boolean description: '' NotifyMis: type: boolean description: '' CustomCheckbox: type: boolean description: '' nullable: true RewardPointsBalance: type: integer description: '' nullable: true Addresses: type: array items: $ref: '#/components/schemas/InfigoApiAddress' description: '' description: '' InfigoUpdateRewardPoints: type: object properties: RewardPoints: type: integer description: '' IsAbsoluteAdjustment: type: boolean description: | If is set to `true`, it will be set to this value. If set to `false`, it will subtract or append. Message: type: string description: '' nullable: true description: '' InfigoOctetStream: type: object description: '' InfigoTouchJobResponseModel: type: object properties: IsSuccess: type: boolean description: '' Errors: type: array items: type: string description: '' nullable: true description: '' description: '' InfigoKeyValuePair_2_String_String: type: object properties: Key: type: string description: '' nullable: true Value: type: string description: '' nullable: true description: '' InfigoItem: type: object properties: VariableSetName: type: string description: | Variable set name. VariableItemName: type: string description: | Variable item name. Value: type: string description: | Value (optional). nullable: true description: '' InfigoApiJobDetails: type: object properties: ProductId: type: integer description: '' ProductSku: type: string description: '' nullable: true ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoKeyValuePair_2_String_String' description: '' Variables: type: array items: $ref: '#/components/schemas/InfigoItem' description: '' description: '' InfigoApiEditorResult: type: object properties: CustomerGuid: type: string description: '' format: uuid JobId: type: string description: '' nullable: true EditorLink: type: string description: '' nullable: true ThumbnailLink: type: string description: '' nullable: true ProductDetails: $ref: '#/components/schemas/InfigoApiJobDetails' ActionId: type: string description: '' format: uuid nullable: true description: '' InfigoApiErrorDetail: type: object properties: Message: type: string description: '' nullable: true Field: type: string description: '' nullable: true AttemptedValue: $ref: '#/components/schemas/InfigoObject' description: '' InfigoApiErrorResponse: type: object properties: ApiErrorCode: enum: - 0 - 1 - 2 - 3 - 4 type: string description: |+ Possible values: `0` - INVALID_INPUT `1` - SERVER_ERROR `2` - UNAUTHORIZED `3` - NOT_FOUND `4` - CONFLICT x-enum-descriptions: - INVALID_INPUT - SERVER_ERROR - UNAUTHORIZED - NOT_FOUND - CONFLICT x-ms-enum: - INVALID_INPUT - SERVER_ERROR - UNAUTHORIZED - NOT_FOUND - CONFLICT x-enumNames: - INVALID_INPUT - SERVER_ERROR - UNAUTHORIZED - NOT_FOUND - CONFLICT x-enum-varnames: - INVALID_INPUT - SERVER_ERROR - UNAUTHORIZED - NOT_FOUND - CONFLICT Message: type: string description: '' nullable: true Errors: type: array items: $ref: '#/components/schemas/InfigoApiErrorDetail' description: '' description: '' InfigoApiEditorLinkToRequest: type: object properties: BaseJobId: type: string description: | Optional BaseJob id. The variable items from the base job are fetched and merged with the ones in this request (with the new ones overriding). nullable: true Quantity: type: integer description: | Quantity for the product. nullable: true GenerateThumbnail: type: boolean description: | If true, a thumbnail with the variable values will be generated. nullable: true ErrorUrl: type: string description: | Error URL for the iFrame to display in case of an authentication error. nullable: true Customer: type: string description: | Optional Customer identifier. Either customer id, guid, or email/username. A new user will be created if nothing provided nullable: true Product: type: string description: | Product Identifier (SKU or Infigo Product Id or BaseJobId). In case the BaseJobId provided, we will use the product that relates to the job. nullable: true ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoKeyValuePair_2_String_String' description: | Product Attributes (list of name/value pairs). VariableItems: type: array items: $ref: '#/components/schemas/InfigoItem' description: | Variable list (list of variable set name/variable item name/value). NotificationUrl: type: string description: | Optional postback URL when the thumbnail is ready. nullable: true description: '' InfigoJobDuplicatedResponse: type: object properties: JobId: type: string description: '' nullable: true description: '' InfigoDuplicateJobRequest: type: object properties: JobId: type: string description: | Job Id. It should start with `d` nullable: true Customer: type: string description: | Optional Customer identifier. Either customer id, guid, or email/username. A new user will be created if nothing provided nullable: true description: '' InfigoHotFolder: type: object properties: Id: type: integer description: '' AccountId: type: integer description: '' Name: type: string description: '' nullable: true Description: type: string description: '' nullable: true Folder: type: string description: '' nullable: true Enabled: type: boolean description: '' PrintLocationId: type: integer description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoOrderProduct: type: object properties: Id: type: integer description: | Infigo order product Id Status: enum: - 25 - 26 - 68 - 69 type: string description: |+ Possible values: `25` - OutputDownloaded `26` - OutputVerified `68` - JobTicketDownloaded `69` - JobTicketVerified x-enum-descriptions: - OutputDownloaded - OutputVerified - JobTicketDownloaded - JobTicketVerified x-ms-enum: - OutputDownloaded - OutputVerified - JobTicketDownloaded - JobTicketVerified x-enumNames: - OutputDownloaded - OutputVerified - JobTicketDownloaded - JobTicketVerified x-enum-varnames: - OutputDownloaded - OutputVerified - JobTicketDownloaded - JobTicketVerified JobType: type: string description: '' nullable: true description: '' InfigoSetJobModel: type: object properties: DownloadId: type: string description: '' format: uuid Status: enum: - 0 - 1 - 2 - 3 type: object description: |+ Possible values: `0` - Created `1` - Downloading `2` - Downloaded `3` - Failed x-enum-descriptions: - Created - Downloading - Downloaded - Failed x-ms-enum: - Created - Downloading - Downloaded - Failed x-enumNames: - Created - Downloading - Downloaded - Failed x-enum-varnames: - Created - Downloading - Downloaded - Failed description: '' InfigoUpdateMisExternalRefRequest: type: object properties: Id: type: string description: | Id ExternalId: type: string description: | External Id nullable: true MisPluginSystemName: type: string description: | System name of the MIS Plugin EntityType: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 type: string description: |+ Type of the entity Possible values: `0` - ProductVariant `1` - Order `2` - Address `3` - Customer `4` - Department `5` - SymphonyItemPrint `6` - SymphonyItemGroup `7` - ProductVariantAttribute `8` - ProductVariantAttributeValue `9` - ProductGroupAttribute `10` - ProductGroupAttributeValue `11` - CheckoutAttribute `12` - ProductSpecificationAttribute `13` - DeliveryMethod `14` - MisApi `15` - ProductVariantAttributeCombination `16` - ProductGroupAttributeCombination `17` - ProductGroup `18` - OrderLine `19` - CheckoutAttributeValue `20` - Language `21` - Country `22` - SavedQuote `23` - HotFolder `24` - UploadLocation `25` - Category `26` - MessageTemplate `27` - Supplier `28` - EditableContent `29` - TaxCategory `30` - CustomerRole `31` - Storefront `32` - RequestContextGroup `33` - ShoppingCartItem `34` - ApiAuthToken `35` - JobId x-enum-descriptions: - ProductVariant - Order - Address - Customer - Department - SymphonyItemPrint - SymphonyItemGroup - ProductVariantAttribute - ProductVariantAttributeValue - ProductGroupAttribute - ProductGroupAttributeValue - CheckoutAttribute - ProductSpecificationAttribute - DeliveryMethod - MisApi - ProductVariantAttributeCombination - ProductGroupAttributeCombination - ProductGroup - OrderLine - CheckoutAttributeValue - Language - Country - SavedQuote - HotFolder - UploadLocation - Category - MessageTemplate - Supplier - EditableContent - TaxCategory - CustomerRole - Storefront - RequestContextGroup - ShoppingCartItem - ApiAuthToken - JobId x-ms-enum: - ProductVariant - Order - Address - Customer - Department - SymphonyItemPrint - SymphonyItemGroup - ProductVariantAttribute - ProductVariantAttributeValue - ProductGroupAttribute - ProductGroupAttributeValue - CheckoutAttribute - ProductSpecificationAttribute - DeliveryMethod - MisApi - ProductVariantAttributeCombination - ProductGroupAttributeCombination - ProductGroup - OrderLine - CheckoutAttributeValue - Language - Country - SavedQuote - HotFolder - UploadLocation - Category - MessageTemplate - Supplier - EditableContent - TaxCategory - CustomerRole - Storefront - RequestContextGroup - ShoppingCartItem - ApiAuthToken - JobId x-enumNames: - ProductVariant - Order - Address - Customer - Department - SymphonyItemPrint - SymphonyItemGroup - ProductVariantAttribute - ProductVariantAttributeValue - ProductGroupAttribute - ProductGroupAttributeValue - CheckoutAttribute - ProductSpecificationAttribute - DeliveryMethod - MisApi - ProductVariantAttributeCombination - ProductGroupAttributeCombination - ProductGroup - OrderLine - CheckoutAttributeValue - Language - Country - SavedQuote - HotFolder - UploadLocation - Category - MessageTemplate - Supplier - EditableContent - TaxCategory - CustomerRole - Storefront - RequestContextGroup - ShoppingCartItem - ApiAuthToken - JobId x-enum-varnames: - ProductVariant - Order - Address - Customer - Department - SymphonyItemPrint - SymphonyItemGroup - ProductVariantAttribute - ProductVariantAttributeValue - ProductGroupAttribute - ProductGroupAttributeValue - CheckoutAttribute - ProductSpecificationAttribute - DeliveryMethod - MisApi - ProductVariantAttributeCombination - ProductGroupAttributeCombination - ProductGroup - OrderLine - CheckoutAttributeValue - Language - Country - SavedQuote - HotFolder - UploadLocation - Category - MessageTemplate - Supplier - EditableContent - TaxCategory - CustomerRole - Storefront - RequestContextGroup - ShoppingCartItem - ApiAuthToken - JobId description: '' InfigoApiCustomTags: type: object properties: CustomTag1: type: string description: '' nullable: true CustomTag2: type: string description: '' nullable: true CustomTag3: type: string description: '' nullable: true CustomTag4: type: string description: '' nullable: true description: '' InfigoCheckoutAttributeValue: type: object properties: Id: type: string description: '' nullable: true Content: type: string description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoCheckoutAttribute: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' Values: type: array items: $ref: '#/components/schemas/InfigoCheckoutAttributeValue' description: '' description: '' InfigoOrderItem: type: object properties: Id: type: integer description: '' OrderGuid: type: string description: '' format: uuid CustomerId: type: integer description: '' CustomerEmail: type: string description: '' nullable: true CustomerUserName: type: string description: '' nullable: true UserIdentifier: type: string description: '' format: uuid CustomerLanguageId: type: integer description: '' CustomerIp: type: string description: '' nullable: true OrderLineItems: type: array items: type: string description: '' nullable: true description: '' DepartmentId: type: integer description: '' nullable: true Status: enum: - 10 - 20 - 30 - 40 - 50 - 60 type: integer description: |+ Possible values: `10` - Open `20` - Paid `30` - Shipped `40` - Complete `50` - Cancelled `60` - Delivered x-enum-descriptions: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-ms-enum: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-enumNames: - Open - Paid - Shipped - Complete - Cancelled - Delivered x-enum-varnames: - Open - Paid - Shipped - Complete - Cancelled - Delivered BillingAddress: $ref: '#/components/schemas/InfigoApiAddress' ShippingAddress: $ref: '#/components/schemas/InfigoApiAddress' ShippingType: type: string description: '' nullable: true CustomerCurrencyCode: type: string description: '' nullable: true ShippingCost: type: integer description: '' Tax: type: integer description: '' OrderTotal: type: integer description: '' PurchaseOrderNumber: type: string description: '' nullable: true OrderDate: type: string description: '' format: date-time nullable: true BudgetUsed: type: integer description: '' CustomTags: $ref: '#/components/schemas/InfigoApiCustomTags' CustomData1: type: string description: '' nullable: true TrackingNumber: type: string description: '' nullable: true OrderState: enum: - 10 - 20 - 30 - 40 type: integer description: |+ Possible values: `10` - Pending `20` - Processing `30` - Complete `40` - Cancelled x-enum-descriptions: - Pending - Processing - Complete - Cancelled x-ms-enum: - Pending - Processing - Complete - Cancelled x-enumNames: - Pending - Processing - Complete - Cancelled x-enum-varnames: - Pending - Processing - Complete - Cancelled ShippingState: enum: - 10 - 20 - 30 - 40 type: integer description: |+ Possible values: `10` - ShippingNotRequired `20` - NotYetShipped `30` - Shipped `40` - Delivered x-enum-descriptions: - ShippingNotRequired - NotYetShipped - Shipped - Delivered x-ms-enum: - ShippingNotRequired - NotYetShipped - Shipped - Delivered x-enumNames: - ShippingNotRequired - NotYetShipped - Shipped - Delivered x-enum-varnames: - ShippingNotRequired - NotYetShipped - Shipped - Delivered PaymentState: enum: - 10 - 20 - 30 - 35 - 40 - 50 - 60 type: integer description: |+ Possible values: `10` - Pending `20` - Authorized `30` - Paid `35` - PartiallyRefunded `40` - Refunded `50` - Voided `60` - Cancelled x-enum-descriptions: - Pending - Authorized - Paid - PartiallyRefunded - Refunded - Voided - Cancelled x-ms-enum: - Pending - Authorized - Paid - PartiallyRefunded - Refunded - Voided - Cancelled x-enumNames: - Pending - Authorized - Paid - PartiallyRefunded - Refunded - Voided - Cancelled x-enum-varnames: - Pending - Authorized - Paid - PartiallyRefunded - Refunded - Voided - Cancelled MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | MIS Configuration mapping CheckoutAttributes: type: array items: $ref: '#/components/schemas/InfigoCheckoutAttribute' description: '' Data: type: array items: $ref: '#/components/schemas/InfigoKeyValuePair_2_String_String' description: | Custom API Meta Data CurrencyRate: type: integer description: '' VatNumber: type: string description: '' nullable: true OrderSubtotalInclTax: type: integer description: '' OrderSubtotalExclTax: type: integer description: '' OrderSubTotalDiscountInclTax: type: integer description: '' OrderSubTotalDiscountExclTax: type: integer description: '' DiscountCodes: type: array items: type: string description: '' nullable: true description: '' TaxRates: type: string description: '' nullable: true OrderTax: type: integer description: '' OrderDiscount: type: integer description: '' RefundedAmount: type: integer description: '' OrderWeight: type: integer description: '' RewardPointsWereAdded: type: boolean description: '' AffiliateId: type: integer description: '' nullable: true PaymentMethodSystemName: type: string description: '' nullable: true PaymentMethodAdditionalFeeInclTax: type: integer description: '' PaymentMethodAdditionalFeeExclTax: type: integer description: '' AuthorizationTransactionId: type: string description: '' nullable: true AuthorizationTransactionCode: type: string description: '' nullable: true AuthorizationTransactionResult: type: string description: '' nullable: true CaptureTransactionId: type: string description: '' nullable: true CaptureTransactionResult: type: string description: '' nullable: true SubscriptionTransactionId: type: string description: '' nullable: true ActualShippingMethod: type: string description: '' nullable: true ShippingMethodSystemName: type: string description: '' nullable: true ShippingMethodCode: type: string description: '' nullable: true ShippingRateComputationMethodSystemName: type: string description: '' nullable: true OrderShippingInclTax: type: integer description: '' OrderShippingExclTax: type: integer description: '' ShippingTaxRate: type: integer description: '' ShippedDateUtc: type: string description: '' format: date-time nullable: true DeliveryDateUtc: type: string description: '' format: date-time nullable: true OrderProcessingFeeExclTax: type: integer description: '' OrderProcessingFeeInclTax: type: integer description: '' OrderLineHandlingFeeExclTax: type: integer description: '' OrderLineHandlingFeeInclTax: type: integer description: '' ProductHandlingFeeExclTax: type: integer description: '' ProductHandlingFeeInclTax: type: integer description: '' description: '' InfigoPlaceOrderHelper: type: object properties: shippingAddress: $ref: '#/components/schemas/InfigoApiAddress' billingAddress: $ref: '#/components/schemas/InfigoApiAddress' shippingMethod: type: string description: | If a specific shipping method is set, it will be used for the order. However, if no shipping method is specified, the store's default shipping method will be applied. nullable: true paid: type: boolean description: | This flag determines whether the order should be automatically marked as paid. By default, it is set to `false`. nullable: true description: '' InfigoApiRecordOrderKeyValue: type: object properties: Key: type: string description: '' nullable: true Value: type: string description: '' nullable: true description: '' InfigoApiOrderLineItem: type: object properties: ProductSKU: type: string description: '' nullable: true NopProductId: type: integer description: '' PdfExternalUrl: type: string description: | The URL to the PDF for generating multipart product output. Required if the orderline is for a Multipart product. Note: Ordering without artwork, product configuration, is not supported via API. nullable: true ProductVariantAttributes: type: array items: $ref: '#/components/schemas/InfigoApiRecordOrderKeyValue' description: '' PdfHash: type: string description: | The hash of the PdfExternalUrl used to verify the integrity of the PDF. nullable: true Quantity: type: integer description: '' ShippedQuantity: type: integer description: '' JobId: type: string description: '' nullable: true ExtraData: type: array items: $ref: '#/components/schemas/InfigoKeyValuePair_2_String_String' description: '' CustomTags: $ref: '#/components/schemas/InfigoApiCustomTags' CustomData1: type: string description: '' nullable: true DeliveryType: type: array items: type: string description: '' nullable: true description: '' description: '' InfigoApiRecordOrder: type: object properties: ExternalOrderId: type: string description: | The External Order ID serves as a unique identifier for each order, particularly when Infigo is configured to use it as a reference field. This uniqueness ensures that the same order is not placed more than once. nullable: true CallbackUrl: type: string description: '' nullable: true CatfishCustomerId: type: string description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. nullable: true CatfishDeliveryMethod: type: string description: '' nullable: true IsPaymentPaid: type: boolean description: '' PurchaseOrderNumber: type: string description: '' nullable: true DeliveryAddress: $ref: '#/components/schemas/InfigoApiAddress' BillingAddress: $ref: '#/components/schemas/InfigoApiAddress' OrderLineItems: type: array items: $ref: '#/components/schemas/InfigoApiOrderLineItem' description: '' CheckoutAttributes: type: array items: $ref: '#/components/schemas/InfigoApiRecordOrderKeyValue' description: '' ExtraData: type: array items: $ref: '#/components/schemas/InfigoKeyValuePair_2_String_String' description: '' CustomTags: $ref: '#/components/schemas/InfigoApiCustomTags' CustomData1: type: string description: '' nullable: true RequestContextGroupId: type: integer description: '' nullable: true description: '' InfigoApiQuoteEntity: type: object properties: Id: type: integer description: '' CustomReference: type: string description: '' nullable: true description: '' InfigoOrderLineItemHistoryItem: type: object properties: Status: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 46 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 type: integer description: |+ Possible values: `0` - Nothing `1` - Creating `2` - InBasket `3` - Ordered `4` - OutputCreationStarted `5` - OutputCreated `6` - OutputCreationFailed `7` - InHotFolder `8` - Printed `9` - Shipped `10` - AwaitingApproval `11` - AwaitingData `12` - AwaitingParts `13` - AwaitingProof `14` - InArtworking `15` - InFinishing `16` - InPacking `17` - InProduction `18` - InReprographics `19` - OnHold `20` - FutureOrder `21` - UnapprovedOrder `22` - Rejected `23` - Approved `24` - RecreationRequested `25` - OutputDownloaded `26` - OutputVerified `27` - SentEmail `28` - SentEmailFailed `29` - SmsDispatched `30` - EmailBounced `31` - EmailBouncedAndPrintJobCreated `32` - PrintJobVersion `33` - NoEmailBounceActionRequired `34` - SmsDispatching `35` - MisNotified `36` - TemplateProductCreated `37` - TemplateProductCreationFailed `38` - ExternalOutputRequested `39` - ExternalOutputJobClosed `40` - ActionRun `41` - MisNotificationRetrigger `46` - ReadyForCollection `49` - Blocked `50` - ArtworkUploaded `51` - MisOrderProcessed `52` - MisAssetsOk `53` - MisAssetsFailed `54` - MisFailed `55` - CustomStatus `56` - CustomStatusHidden `57` - MisAdditionalActionRequired `58` - MisManifested `59` - CopyToHotFolderFailed `60` - CopyToHotFolderSkipped `61` - PartiallyApproved `62` - JobDataDeleted `63` - ValidationFailed `64` - ValidationFinished `65` - ApprovalJobUpdated `66` - MisPartiallyFailed `67` - OutputDeleted `68` - MisShipped `69` - MisSkipped `70` - RequiresFinalize `71` - ShippedQuantity `72` - MisCustomStatus `73` - Cancelled `74` - JobTicketDownloaded `75` - JobTicketVerified `76` - StatusManuallyRemoved x-enum-descriptions: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - ReadyForCollection - Blocked - ArtworkUploaded - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - MisFailed - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - MisManifested - CopyToHotFolderFailed - CopyToHotFolderSkipped - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - ApprovalJobUpdated - MisPartiallyFailed - OutputDeleted - MisShipped - MisSkipped - RequiresFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-ms-enum: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - ReadyForCollection - Blocked - ArtworkUploaded - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - MisFailed - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - MisManifested - CopyToHotFolderFailed - CopyToHotFolderSkipped - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - ApprovalJobUpdated - MisPartiallyFailed - OutputDeleted - MisShipped - MisSkipped - RequiresFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-enumNames: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - ReadyForCollection - Blocked - ArtworkUploaded - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - MisFailed - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - MisManifested - CopyToHotFolderFailed - CopyToHotFolderSkipped - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - ApprovalJobUpdated - MisPartiallyFailed - OutputDeleted - MisShipped - MisSkipped - RequiresFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-enum-varnames: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - ReadyForCollection - Blocked - ArtworkUploaded - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - MisFailed - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - MisManifested - CopyToHotFolderFailed - CopyToHotFolderSkipped - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - ApprovalJobUpdated - MisPartiallyFailed - OutputDeleted - MisShipped - MisSkipped - RequiresFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved Timestamp: type: string description: '' format: date-time Info: type: string description: '' nullable: true description: '' InfigoOrderLineItemGroup: type: object properties: Name: type: string description: '' nullable: true Description: type: string description: '' nullable: true description: '' InfigoProductAttributeValue: type: object properties: Id: type: string description: '' nullable: true Content: type: string description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoProductAttribute: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' Values: type: array items: $ref: '#/components/schemas/InfigoProductAttributeValue' description: '' description: '' InfigoOrderlineItem: type: object properties: Id: type: string description: '' nullable: true OpvId: type: integer description: '' OrderLineItemGuid: type: string description: '' format: uuid ProductId: type: integer description: '' CustomerId: type: integer description: '' nullable: true Name: type: string description: '' nullable: true CreatedOnUtc: type: string description: '' format: date-time Status: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 46 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 type: integer description: |+ Possible values: `0` - Nothing `1` - Creating `2` - InBasket `3` - Ordered `4` - OutputCreationStarted `5` - OutputCreated `6` - OutputCreationFailed `7` - InHotFolder `8` - Printed `9` - Shipped `10` - AwaitingApproval `11` - AwaitingData `12` - AwaitingParts `13` - AwaitingProof `14` - InArtworking `15` - InFinishing `16` - InPacking `17` - InProduction `18` - InReprographics `19` - OnHold `20` - FutureOrder `21` - UnapprovedOrder `22` - Rejected `23` - Approved `24` - RecreationRequested `25` - OutputDownloaded `26` - OutputVerified `27` - SentEmail `28` - SentEmailFailed `29` - SmsDispatched `30` - EmailBounced `31` - EmailBouncedAndPrintJobCreated `32` - PrintJobVersion `33` - NoEmailBounceActionRequired `34` - SmsDispatching `35` - MisNotified `36` - TemplateProductCreated `37` - TemplateProductCreationFailed `38` - ExternalOutputRequested `39` - ExternalOutputJobClosed `40` - ActionRun `41` - MisNotificationRetrigger `46` - ReadyForCollection `49` - Blocked `50` - ArtworkUploaded `51` - MisOrderProcessed `52` - MisAssetsOk `53` - MisAssetsFailed `54` - MisFailed `55` - CustomStatus `56` - CustomStatusHidden `57` - MisAdditionalActionRequired `58` - MisManifested `59` - CopyToHotFolderFailed `60` - CopyToHotFolderSkipped `61` - PartiallyApproved `62` - JobDataDeleted `63` - ValidationFailed `64` - ValidationFinished `65` - ApprovalJobUpdated `66` - MisPartiallyFailed `67` - OutputDeleted `68` - MisShipped `69` - MisSkipped `70` - RequiresFinalize `71` - ShippedQuantity `72` - MisCustomStatus `73` - Cancelled `74` - JobTicketDownloaded `75` - JobTicketVerified `76` - StatusManuallyRemoved x-enum-descriptions: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - ReadyForCollection - Blocked - ArtworkUploaded - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - MisFailed - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - MisManifested - CopyToHotFolderFailed - CopyToHotFolderSkipped - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - ApprovalJobUpdated - MisPartiallyFailed - OutputDeleted - MisShipped - MisSkipped - RequiresFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-ms-enum: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - ReadyForCollection - Blocked - ArtworkUploaded - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - MisFailed - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - MisManifested - CopyToHotFolderFailed - CopyToHotFolderSkipped - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - ApprovalJobUpdated - MisPartiallyFailed - OutputDeleted - MisShipped - MisSkipped - RequiresFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-enumNames: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - ReadyForCollection - Blocked - ArtworkUploaded - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - MisFailed - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - MisManifested - CopyToHotFolderFailed - CopyToHotFolderSkipped - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - ApprovalJobUpdated - MisPartiallyFailed - OutputDeleted - MisShipped - MisSkipped - RequiresFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved x-enum-varnames: - Nothing - Creating - InBasket - Ordered - OutputCreationStarted - OutputCreated - OutputCreationFailed - InHotFolder - Printed - Shipped - AwaitingApproval - AwaitingData - AwaitingParts - AwaitingProof - InArtworking - InFinishing - InPacking - InProduction - InReprographics - OnHold - FutureOrder - UnapprovedOrder - Rejected - Approved - RecreationRequested - OutputDownloaded - OutputVerified - SentEmail - SentEmailFailed - SmsDispatched - EmailBounced - EmailBouncedAndPrintJobCreated - PrintJobVersion - NoEmailBounceActionRequired - SmsDispatching - MisNotified - TemplateProductCreated - TemplateProductCreationFailed - ExternalOutputRequested - ExternalOutputJobClosed - ActionRun - MisNotificationRetrigger - ReadyForCollection - Blocked - ArtworkUploaded - MisOrderProcessed - MisAssetsOk - MisAssetsFailed - MisFailed - CustomStatus - CustomStatusHidden - MisAdditionalActionRequired - MisManifested - CopyToHotFolderFailed - CopyToHotFolderSkipped - PartiallyApproved - JobDataDeleted - ValidationFailed - ValidationFinished - ApprovalJobUpdated - MisPartiallyFailed - OutputDeleted - MisShipped - MisSkipped - RequiresFinalize - ShippedQuantity - MisCustomStatus - Cancelled - JobTicketDownloaded - JobTicketVerified - StatusManuallyRemoved IsCancelled: type: boolean description: '' Type: enum: - 10 - 20 - 30 - 40 - 50 - 70 type: integer description: |+ Possible values: `10` - Normal `20` - Variable `30` - Static `40` - MultiPart `50` - Dynamic `70` - Symphony x-enum-descriptions: - Normal - Variable - Static - MultiPart - Dynamic - Symphony x-ms-enum: - Normal - Variable - Static - MultiPart - Dynamic - Symphony x-enumNames: - Normal - Variable - Static - MultiPart - Dynamic - Symphony x-enum-varnames: - Normal - Variable - Static - MultiPart - Dynamic - Symphony DownloadCount: type: integer description: '' PreviewUrls: type: array items: type: string description: '' nullable: true description: '' ThumbnailUrls: type: array items: type: string description: '' nullable: true description: '' Tags: type: array items: type: string description: '' nullable: true description: '' Price: type: integer description: '' Quantity: type: integer description: '' ShippedQuantity: type: integer description: '' Notes: type: string description: '' nullable: true CustomName: type: string description: '' nullable: true Sku: type: string description: '' nullable: true UnitPriceInclTax: type: integer description: '' UnitPriceExclTax: type: integer description: '' SubTotalPriceInclTax: type: integer description: '' SubTotalPriceExclTax: type: integer description: '' DiscountAmountInclTax: type: integer description: '' DiscountAmountExclTax: type: integer description: '' Quote: $ref: '#/components/schemas/InfigoApiQuoteEntity' CustomTags: $ref: '#/components/schemas/InfigoApiCustomTags' CustomData1: type: string description: '' nullable: true History: type: array items: $ref: '#/components/schemas/InfigoOrderLineItemHistoryItem' description: '' Group: $ref: '#/components/schemas/InfigoOrderLineItemGroup' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttribute' description: '' DeliveryType: type: array items: type: string description: '' nullable: true description: '' description: '' InfigoOutputCreationRequest: type: object properties: CallbackUrl: type: string description: | When a hotfolder ID is not provided, a callback URL, which is an endpoint for notifying about successful output creation, is required. nullable: true HotFolderId: type: integer description: | When the Callback URL is empty, it is essential to provide a Hotfolder ID. The Hotfolder ID specifies where the output should be placed after it is created. nullable: true DirectDownload: type: boolean description: | This flag determines how the output will be delivered. When set, the output will be downloaded directly from Catfish. If not set, Catfish will use the Callback URL to upload the output to the provided URL. description: '' InfigoUpdateNotesRequest: type: object properties: JobId: type: string description: '' nullable: true Notes: type: string description: '' nullable: true description: '' InfigoPrintLocation: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true Description: type: string description: '' nullable: true AccountId: type: integer description: '' description: '' InfigoProductGroupAttributeCombination: type: object properties: Id: type: integer description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeInfo' description: '' AllowOutOfStockOrders: enum: - 0 - 1 - 2 type: string description: |+ Possible values: `0` - NoBackorders `1` - AllowQtyBelow0 `2` - AllowQtyBelow0AndNotifyCustomer x-enum-descriptions: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-ms-enum: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-enumNames: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer x-enum-varnames: - NoBackorders - AllowQtyBelow0 - AllowQtyBelow0AndNotifyCustomer Sku: type: string description: '' nullable: true Priority: type: integer description: '' StockValue: type: integer description: '' MinimumBasketQuantity: type: integer description: '' nullable: true MaximumBasketQuantity: type: integer description: '' nullable: true Published: type: boolean description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoApiProductGroupInfo: type: object properties: GroupId: type: integer description: '' AdminComment: type: string description: '' nullable: true Name: type: string description: '' nullable: true AvailableStartDateTimeUtc: type: string description: '' format: date-time nullable: true AvailableEndDateTimeUtc: type: string description: '' format: date-time nullable: true DefaultBasketQuantity: type: integer description: '' MinimumBasketQuantity: type: integer description: '' MaximumBasketQuantity: type: integer description: '' OrderPackQuantity: type: integer description: '' QuantitySelectorMode: enum: - 0 - 1 type: string description: |+ Possible values: `0` - Units `1` - Packs x-enum-descriptions: - Units - Packs x-ms-enum: - Units - Packs x-enumNames: - Units - Packs x-enum-varnames: - Units - Packs Price: type: integer description: '' HasQuantityBasedPricing: type: boolean description: '' nullable: true ShowOrderlineTotal: type: boolean description: '' TierPrices: type: array items: $ref: '#/components/schemas/InfigoApiTierPrice' description: '' ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductAttributeInfo' description: '' AttributeCombinations: type: array items: $ref: '#/components/schemas/InfigoProductGroupAttributeCombination' description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' InfigoProductGroupAttributeValueRequest: type: object properties: MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' Name: type: string description: | The name of the product attribute value. nullable: true FriendlyName: type: string description: | A user-friendly name for the product attribute value. nullable: true HtmlInfo: type: string description: | HTML content providing additional information about the product attribute value. nullable: true DisplayOrder: type: integer description: | The display order of the product attribute value in the UI. IsDisabled: type: boolean description: | Indicates whether the product attribute value is disabled and should not be available for selection. IsPreselected: type: boolean description: | Indicates whether the product attribute value is selected by default. ProductionOffsetAdjustment: type: integer description: | The adjustment to the product's production time when this value is selected. PriceAdjustment: type: integer description: | The price adjustment applied to the product's base price when this value is selected. WeightAdjustment: type: integer description: | The weight adjustment applied to the product when this value is selected. WidthAdjustment: type: integer description: | The adjustment applied to the product's width when this value is selected. HeightAdjustment: type: integer description: | The adjustment applied to the product's height when this value is selected. LengthAdjustment: type: integer description: | The adjustment applied to the product's length when this value is selected. PriceAdjustmentType: enum: - 0 - 1 type: string description: |+ The type of price adjustment applied, indicating whether it's an absolute value or a percentage. Possible values: `0` - Percent `1` - Absolute x-enum-descriptions: - Percent - Absolute x-ms-enum: - Percent - Absolute x-enumNames: - Percent - Absolute x-enum-varnames: - Percent - Absolute description: '' InfigoProductGroupAttributeRequest: type: object properties: ProductAttributeValues: type: array items: $ref: '#/components/schemas/InfigoProductGroupAttributeValueRequest' description: | A list of product attribute values to assign to product attribute. An empty list will delete the assigned attributes values. MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. Id: type: integer description: | The ID of the product attribute you want to assign to the product. nullable: true Name: type: string description: | The name of the product attribute. Not mandatory if ID provided nullable: true ProductPageLabel: type: string description: | The label of the product attribute that will be displayed on the product page. Please use "Description" instead of ProductPageLabel(obsolete) to pass the value nullable: true IsRequired: type: boolean description: | Indicates whether the product attribute is required. DisplayOrder: type: integer description: | The display order of the product attribute in the UI. IsHidden: type: boolean description: | Indicates whether the product attribute is hidden from the UI. AttributeControlType: enum: - 1 - 2 - 3 - 4 - 10 - 20 - 30 - 40 - 50 - 60 - 70 - 999 type: string description: |+ Possible values: `1` - DropdownList `2` - RadioList `3` - Checkboxes `4` - TextBox `10` - MultilineTextbox `20` - Datepicker `30` - FileUpload `40` - Info `50` - HtmlSchema `60` - System `70` - Number `999` - Hidden x-enum-descriptions: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-ms-enum: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-enumNames: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden x-enum-varnames: - DropdownList - RadioList - Checkboxes - TextBox - MultilineTextbox - Datepicker - FileUpload - Info - HtmlSchema - System - Number - Hidden description: '' InfigoCreateProductGroupRequest: type: object properties: AdminComment: type: string description: '' nullable: true Name: type: string description: | The name for the group. nullable: true AvailableStartDateTimeUtc: type: string description: | Indicated the start of the products availability. Provide value in UTC, as it will be converted in storefront timezone format: date-time nullable: true AvailableEndDateTimeUtc: type: string description: | Indicated the end of the products availability. Provide value in UTC, as it will be converted in storefront timezone format: date-time nullable: true DefaultBasketQuantity: type: integer description: '' nullable: true MinimumBasketQuantity: type: integer description: '' nullable: true MaximumBasketQuantity: type: integer description: '' nullable: true OrderPackQuantity: type: integer description: | Indicates the quantity for packing depending on QuantitySelectorMode. nullable: true QuantitySelectorMode: enum: - 0 - 1 type: string description: |+ Indicates the unit for packing. Possible values: `0` - Units `1` - Packs x-enum-descriptions: - Units - Packs x-ms-enum: - Units - Packs x-enumNames: - Units - Packs x-enum-varnames: - Units - Packs Price: type: integer description: | The price products in a group will inherit. nullable: true HasQuantityBasedPricing: type: boolean description: | Indicated whether the products in the group will have quantity based pricing. nullable: true ShowOrderlineTotal: type: boolean description: | Indicated whether the products in the group will have show tier prices per orderline. TierPrices: type: array items: $ref: '#/components/schemas/InfigoApiTierPrice' description: | A list of tier prices to provide when HasQuantityBasedPricing is enabled. ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductGroupAttributeRequest' description: | A list of group attributes to assign to group. An empty list will delete the assigned attributes values. AttributeCombinations: type: array items: $ref: '#/components/schemas/InfigoProductAttributeCombinationRequest' description: | A list of group attributes combinations out of assigned attributes to the group. An empty list will delete the assigned attributes values. MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. description: '' InfigoUpdateProductGroupRequest: type: object properties: Id: type: integer description: '' AdminComment: type: string description: '' nullable: true Name: type: string description: | The name for the group. nullable: true AvailableStartDateTimeUtc: type: string description: | Indicated the start of the products availability. Provide value in UTC, as it will be converted in storefront timezone format: date-time nullable: true AvailableEndDateTimeUtc: type: string description: | Indicated the end of the products availability. Provide value in UTC, as it will be converted in storefront timezone format: date-time nullable: true DefaultBasketQuantity: type: integer description: '' nullable: true MinimumBasketQuantity: type: integer description: '' nullable: true MaximumBasketQuantity: type: integer description: '' nullable: true OrderPackQuantity: type: integer description: | Indicates the quantity for packing depending on QuantitySelectorMode. nullable: true QuantitySelectorMode: enum: - 0 - 1 type: string description: |+ Indicates the unit for packing. Possible values: `0` - Units `1` - Packs x-enum-descriptions: - Units - Packs x-ms-enum: - Units - Packs x-enumNames: - Units - Packs x-enum-varnames: - Units - Packs Price: type: integer description: | The price products in a group will inherit. nullable: true HasQuantityBasedPricing: type: boolean description: | Indicated whether the products in the group will have quantity based pricing. nullable: true ShowOrderlineTotal: type: boolean description: | Indicated whether the products in the group will have show tier prices per orderline. TierPrices: type: array items: $ref: '#/components/schemas/InfigoApiTierPrice' description: | A list of tier prices to provide when HasQuantityBasedPricing is enabled. ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoProductGroupAttributeRequest' description: | A list of group attributes to assign to group. An empty list will delete the assigned attributes values. AttributeCombinations: type: array items: $ref: '#/components/schemas/InfigoProductAttributeCombinationRequest' description: | A list of group attributes combinations out of assigned attributes to the group. An empty list will delete the assigned attributes values. MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: | This will include the reference/link between this entity and an external system, with management handled by a MIS Plugin. description: '' InfigoApiProductVariantKeyValue: type: object properties: Key: type: string description: | Attribute name nullable: true Value: type: string description: | Attribute value nullable: true description: '' InfigoQuoteAttributeMetaData: type: object properties: Name: type: string description: | Attribute System name nullable: true Locked: type: boolean description: | This field indicates whether an attribute with the name `(Name)` is locked and cannot be changed. description: '' InfigoQuoteMetaData: type: object properties: Attributes: type: array items: $ref: '#/components/schemas/InfigoQuoteAttributeMetaData' description: '' LockQuantity: type: boolean description: | If this option is set to `true`, the quantity selector will be disabled. LockMarkup: type: boolean description: | If this option is set to `true`, the markup selector will be disabled. description: '' InfigoApiQuoteCreate: type: object properties: NumberOfClones: type: integer description: | This field specifies how many clones of the same quote should be created. default: '0' nullable: true CreatedByCustomerId: type: string description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. nullable: true Id: type: integer description: | Quote Id, is ignored for create quote calls Name: maxLength: 2000 type: string description: | Quote name example: SampleName CreatedOnUtc: type: string description: '' format: date-time CustomReference: maxLength: 2000 type: string description: | Quote Custom Reference nullable: true NopProductId: type: integer description: | Infigo Product Id ProductVariantAttributes: type: array items: $ref: '#/components/schemas/InfigoApiProductVariantKeyValue' description: | This is a list of product attributes that will be assigned to the quote. These attributes should match the product attributes. If at attribute is of type `text` then the value can be any string, if the attribute is of type dropdown - value should be a valid Attribute Value Name Quantity: type: integer description: | Quantity, this number should not exceed Products Minimum and Maximum Order Quantity, It should also respect the Order pack Quantity constraint Price: type: integer description: | If you wish to set a fixed price for each quote, you can specify a value. This value will represent the price per unit. nullable: true MarkupType: enum: - 0 - 1 - 2 - 3 type: string description: |+ If you wish you can apply a markup to the price. The markup can be a percentage, an absolute value or a fixed value. If you wish to apply a markup, you should also specify the markup amount. Possible values: `0` - None `1` - Percentage `2` - Absolute `3` - Fixed nullable: true x-enum-descriptions: - None - Percentage - Absolute - Fixed x-ms-enum: - None - Percentage - Absolute - Fixed x-enumNames: - None - Percentage - Absolute - Fixed x-enum-varnames: - None - Percentage - Absolute - Fixed MarkupAmount: type: integer description: | The markup amount can be a percentage, an absolute value or a fixed value. The markup amount should be a positive number or negative for the absolute adjustment. nullable: true QuoteTypeId: enum: - 0 - 1 - 2 - 3 type: integer description: |+ Possible values: `0` - Infinite `1` - OneTime `2` - NTimes `3` - Request x-enum-descriptions: - Infinite - OneTime - NTimes - Request x-ms-enum: - Infinite - OneTime - NTimes - Request x-enumNames: - Infinite - OneTime - NTimes - Request x-enum-varnames: - Infinite - OneTime - NTimes - Request QuoteType: enum: - 0 - 1 - 2 - 3 type: string description: |+ Possible values: `0` - Infinite `1` - OneTime `2` - NTimes `3` - Request x-enum-descriptions: - Infinite - OneTime - NTimes - Request x-ms-enum: - Infinite - OneTime - NTimes - Request x-enumNames: - Infinite - OneTime - NTimes - Request x-enum-varnames: - Infinite - OneTime - NTimes - Request MaxUsageCount: type: integer description: | The maximum usage count for a quote becomes relevant when the quote usage type is set to NTimes This count specifies the maximum number of times the quote can be used. nullable: true ParentQuoteId: type: integer description: '' nullable: true InfoText: type: string description: '' nullable: true LifeSpanDays: type: integer description: '' nullable: true MetaData: $ref: '#/components/schemas/InfigoQuoteMetaData' CatfishCustomerId: type: string description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. CustomTag: type: string description: | This field specifies the custom tag that can be used to filter quotes. nullable: true description: '' InfigoApiQuoteEdit: type: object properties: Status: enum: - 0 - 10 - 20 - 30 - 40 - 60 type: string description: |+ Possible values: `0` - Active `10` - Inactive `20` - Completed `30` - Expired `40` - Archived `60` - Deleted nullable: true x-enum-descriptions: - Active - Inactive - Completed - Expired - Archived - Deleted x-ms-enum: - Active - Inactive - Completed - Expired - Archived - Deleted x-enumNames: - Active - Inactive - Completed - Expired - Archived - Deleted x-enum-varnames: - Active - Inactive - Completed - Expired - Archived - Deleted CreatedByCustomerId: type: string description: '' nullable: true Id: type: integer description: | Quote Id, is ignored for create quote calls Name: maxLength: 2000 type: string description: | Quote name example: SampleName CreatedOnUtc: type: string description: '' format: date-time CustomReference: maxLength: 2000 type: string description: | Quote Custom Reference nullable: true NopProductId: type: integer description: | Infigo Product Id ProductVariantAttributes: type: array items: $ref: '#/components/schemas/InfigoApiProductVariantKeyValue' description: | This is a list of product attributes that will be assigned to the quote. These attributes should match the product attributes. If at attribute is of type `text` then the value can be any string, if the attribute is of type dropdown - value should be a valid Attribute Value Name Quantity: type: integer description: | Quantity, this number should not exceed Products Minimum and Maximum Order Quantity, It should also respect the Order pack Quantity constraint Price: type: integer description: | If you wish to set a fixed price for each quote, you can specify a value. This value will represent the price per unit. nullable: true MarkupType: enum: - 0 - 1 - 2 - 3 type: string description: |+ If you wish you can apply a markup to the price. The markup can be a percentage, an absolute value or a fixed value. If you wish to apply a markup, you should also specify the markup amount. Possible values: `0` - None `1` - Percentage `2` - Absolute `3` - Fixed nullable: true x-enum-descriptions: - None - Percentage - Absolute - Fixed x-ms-enum: - None - Percentage - Absolute - Fixed x-enumNames: - None - Percentage - Absolute - Fixed x-enum-varnames: - None - Percentage - Absolute - Fixed MarkupAmount: type: integer description: | The markup amount can be a percentage, an absolute value or a fixed value. The markup amount should be a positive number or negative for the absolute adjustment. nullable: true QuoteTypeId: enum: - 0 - 1 - 2 - 3 type: integer description: |+ Possible values: `0` - Infinite `1` - OneTime `2` - NTimes `3` - Request x-enum-descriptions: - Infinite - OneTime - NTimes - Request x-ms-enum: - Infinite - OneTime - NTimes - Request x-enumNames: - Infinite - OneTime - NTimes - Request x-enum-varnames: - Infinite - OneTime - NTimes - Request QuoteType: enum: - 0 - 1 - 2 - 3 type: string description: |+ Possible values: `0` - Infinite `1` - OneTime `2` - NTimes `3` - Request x-enum-descriptions: - Infinite - OneTime - NTimes - Request x-ms-enum: - Infinite - OneTime - NTimes - Request x-enumNames: - Infinite - OneTime - NTimes - Request x-enum-varnames: - Infinite - OneTime - NTimes - Request MaxUsageCount: type: integer description: | The maximum usage count for a quote becomes relevant when the quote usage type is set to NTimes This count specifies the maximum number of times the quote can be used. nullable: true ParentQuoteId: type: integer description: '' nullable: true InfoText: type: string description: '' nullable: true LifeSpanDays: type: integer description: '' nullable: true MetaData: $ref: '#/components/schemas/InfigoQuoteMetaData' CatfishCustomerId: type: string description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. CustomTag: type: string description: | This field specifies the custom tag that can be used to filter quotes. nullable: true description: '' InfigoUsages: type: object properties: OrderId: type: string description: '' nullable: true JobId: type: string description: '' nullable: true description: '' InfigoApiGetQuote: type: object properties: CreatedByCustomerId: type: string description: '' nullable: true Usages: enum: - 0 - 1 - 2 - 3 type: array items: $ref: '#/components/schemas/InfigoUsages' description: |+ Possible values: `0` - Infinite `1` - OneTime `2` - NTimes `3` - Request x-enum-descriptions: - Infinite - OneTime - NTimes - Request x-ms-enum: - Infinite - OneTime - NTimes - Request x-enumNames: - Infinite - OneTime - NTimes - Request x-enum-varnames: - Infinite - OneTime - NTimes - Request MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' Status: enum: - 0 - 10 - 20 - 30 - 40 - 60 type: string description: |+ Possible values: `0` - Active `10` - Inactive `20` - Completed `30` - Expired `40` - Archived `60` - Deleted nullable: true x-enum-descriptions: - Active - Inactive - Completed - Expired - Archived - Deleted x-ms-enum: - Active - Inactive - Completed - Expired - Archived - Deleted x-enumNames: - Active - Inactive - Completed - Expired - Archived - Deleted x-enum-varnames: - Active - Inactive - Completed - Expired - Archived - Deleted Id: type: integer description: | Quote Id, is ignored for create quote calls Name: maxLength: 2000 type: string description: | Quote name example: SampleName CreatedOnUtc: type: string description: '' format: date-time CustomReference: maxLength: 2000 type: string description: | Quote Custom Reference nullable: true NopProductId: type: integer description: | Infigo Product Id ProductVariantAttributes: type: array items: $ref: '#/components/schemas/InfigoApiProductVariantKeyValue' description: | This is a list of product attributes that will be assigned to the quote. These attributes should match the product attributes. If at attribute is of type `text` then the value can be any string, if the attribute is of type dropdown - value should be a valid Attribute Value Name Quantity: type: integer description: | Quantity, this number should not exceed Products Minimum and Maximum Order Quantity, It should also respect the Order pack Quantity constraint Price: type: integer description: | If you wish to set a fixed price for each quote, you can specify a value. This value will represent the price per unit. nullable: true MarkupType: enum: - 0 - 1 - 2 - 3 type: string description: |+ If you wish you can apply a markup to the price. The markup can be a percentage, an absolute value or a fixed value. If you wish to apply a markup, you should also specify the markup amount. Possible values: `0` - None `1` - Percentage `2` - Absolute `3` - Fixed nullable: true x-enum-descriptions: - None - Percentage - Absolute - Fixed x-ms-enum: - None - Percentage - Absolute - Fixed x-enumNames: - None - Percentage - Absolute - Fixed x-enum-varnames: - None - Percentage - Absolute - Fixed MarkupAmount: type: integer description: | The markup amount can be a percentage, an absolute value or a fixed value. The markup amount should be a positive number or negative for the absolute adjustment. nullable: true QuoteTypeId: enum: - 0 - 1 - 2 - 3 type: integer description: |+ Possible values: `0` - Infinite `1` - OneTime `2` - NTimes `3` - Request x-enum-descriptions: - Infinite - OneTime - NTimes - Request x-ms-enum: - Infinite - OneTime - NTimes - Request x-enumNames: - Infinite - OneTime - NTimes - Request x-enum-varnames: - Infinite - OneTime - NTimes - Request QuoteType: enum: - 0 - 1 - 2 - 3 type: string description: |+ Possible values: `0` - Infinite `1` - OneTime `2` - NTimes `3` - Request x-enum-descriptions: - Infinite - OneTime - NTimes - Request x-ms-enum: - Infinite - OneTime - NTimes - Request x-enumNames: - Infinite - OneTime - NTimes - Request x-enum-varnames: - Infinite - OneTime - NTimes - Request MaxUsageCount: type: integer description: | The maximum usage count for a quote becomes relevant when the quote usage type is set to NTimes This count specifies the maximum number of times the quote can be used. nullable: true ParentQuoteId: type: integer description: '' nullable: true InfoText: type: string description: '' nullable: true LifeSpanDays: type: integer description: '' nullable: true MetaData: $ref: '#/components/schemas/InfigoQuoteMetaData' CatfishCustomerId: type: string description: | The customer identifier is a required parameter for this API, and it can be one of the following values: - `Id`: Use the customer's unique numeric identifier by including it in the **path**. - `Guid`: Use the customer's unique globally-unique identifier (GUID). Include it in the **query string**. - `Username`: Use the customer's username. Include it in the **query string**. - `Email`: Use the customer's email address. Include it in the **query string**. CustomTag: type: string description: | This field specifies the custom tag that can be used to filter quotes. nullable: true description: '' InfigoApiCustomerSsoResult: type: object properties: CreatedUser: type: boolean description: '' LoginUrl: type: string description: '' nullable: true Token: $ref: '#/components/schemas/InfigoApiCustomerToken' description: '' InfigoGetStorefrontAdminModel: type: object properties: ApiAuthTokens: type: array items: type: string description: '' nullable: true description: '' Id: type: integer description: '' Name: type: string description: '' nullable: true StatusId: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: |+ Possible values: `1` - Active `2` - Inactive `3` - Disabled `4` - Deleted `5` - Test `6` - InitializationPending `7` - Initializing `8` - InitializationFailed x-enum-descriptions: - Active - Inactive - Disabled - Deleted - Test - InitializationPending - Initializing - InitializationFailed x-ms-enum: - Active - Inactive - Disabled - Deleted - Test - InitializationPending - Initializing - InitializationFailed x-enumNames: - Active - Inactive - Disabled - Deleted - Test - InitializationPending - Initializing - InitializationFailed x-enum-varnames: - Active - Inactive - Disabled - Deleted - Test - InitializationPending - Initializing - InitializationFailed StatusString: type: string description: '' nullable: true Aliases: type: array items: type: string description: '' nullable: true description: '' description: '' InfigoCreateStorefrontModelResult: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true description: '' InfigoBundlesModel: type: object properties: Name: type: string description: '' nullable: true Options: $ref: '#/components/schemas/InfigoObject' AdvancedOptions: $ref: '#/components/schemas/InfigoObject' description: '' InfigoCreateStorefrontModel: type: object properties: DefaultAlias: type: string description: | Default alias to use Bundles: type: array items: $ref: '#/components/schemas/InfigoBundlesModel' description: | Additional list of bundles which will be applied Name: type: string description: | Storefront name Description: type: string description: | Storefront Description nullable: true Aliases: type: array items: type: string description: '' nullable: true description: | Aliases description: '' InfigoUpdateStorefrontModel: type: object properties: StatusId: enum: - 1 - 2 - 3 type: string description: |+ Possible values: `1` - Active `2` - Inactive `3` - Test nullable: true x-enum-descriptions: - Active - Inactive - Test x-ms-enum: - Active - Inactive - Test x-enumNames: - Active - Inactive - Test x-enum-varnames: - Active - Inactive - Test Name: type: string description: | Storefront name Description: type: string description: | Storefront Description nullable: true Aliases: type: array items: type: string description: '' nullable: true description: | Aliases description: '' InfigoApiAuthenticationTokenModelResult: type: object properties: ApiKey: type: string description: '' nullable: true description: '' InfigoGetStorefrontModel: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true StatusId: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: |+ Possible values: `1` - Active `2` - Inactive `3` - Disabled `4` - Deleted `5` - Test `6` - InitializationPending `7` - Initializing `8` - InitializationFailed x-enum-descriptions: - Active - Inactive - Disabled - Deleted - Test - InitializationPending - Initializing - InitializationFailed x-ms-enum: - Active - Inactive - Disabled - Deleted - Test - InitializationPending - Initializing - InitializationFailed x-enumNames: - Active - Inactive - Disabled - Deleted - Test - InitializationPending - Initializing - InitializationFailed x-enum-varnames: - Active - Inactive - Disabled - Deleted - Test - InitializationPending - Initializing - InitializationFailed StatusString: type: string description: '' nullable: true Aliases: type: array items: type: string description: '' nullable: true description: '' description: '' InfigoStorefrontSetupModel: type: object properties: PackagingSlipFileNamePattern: type: string description: '' nullable: true InvoiceFileNamePattern: type: string description: '' nullable: true JobTicketFileNamePattern: type: string description: '' nullable: true description: '' InfigoApiResultInfo: type: object properties: CustomerGuid: type: string description: '' format: uuid JobId: type: string description: '' nullable: true EditLink: type: string description: '' nullable: true ThumbnailLink: type: string description: '' nullable: true Details: $ref: '#/components/schemas/InfigoApiJobDetails' ActionId: type: string description: '' format: uuid nullable: true description: '' InfigoApiThumbnailResponse: type: object properties: ContextInfo: $ref: '#/components/schemas/InfigoContextInfo' ApiResult: $ref: '#/components/schemas/InfigoApiResultInfo' description: '' InfigoApiThumbnailRequest: type: object properties: Customer: type: string description: | Optional Customer identifier. Either customer id, guid, or email/username. A new user will be created if nothing provided nullable: true Product: type: string description: | Product Identifier (SKU or Infigo Product Id or BaseJobId). In case the BaseJobId provided, we will use the product that relates to the job. nullable: true ProductAttributes: type: array items: $ref: '#/components/schemas/InfigoKeyValuePair_2_String_String' description: | Product Attributes (list of name/value pairs). VariableItems: type: array items: $ref: '#/components/schemas/InfigoItem' description: | Variable list (list of variable set name/variable item name/value). NotificationUrl: type: string description: | Optional postback URL when the thumbnail is ready. nullable: true description: '' InfigoUploadLocation: type: object properties: Id: type: integer description: '' Name: type: string description: '' nullable: true Description: type: string description: '' nullable: true Enabled: type: boolean description: '' MisConfigurations: type: array items: $ref: '#/components/schemas/InfigoApiMisConfig' description: '' description: '' securitySchemes: Authorization: type: apiKey description: | ## Authentication and Security ### Overview To ensure secure access to Infigo's endpoints, an API Token is required for authentication. Follow these steps to obtain and use the API Token: ### Requesting an API Token 1. Start by raising a support ticket with our dedicated Support Desk. [Create a ticket here](https://infigosoftware.zendesk.com/hc/en-us/requests/new). 2. In your support ticket, kindly request the creation of a new API Token specifically for your designated storefront. 3. Our support team will promptly generate the requested API Token and provide it to you. ### Using the API Token Our API relies on basic authentication for enhanced security. When using tools like Postman to test API requests, follow these steps to include the API Token: 1. If you haven't already, download and install [Postman](https://infigosoftware.zendesk.com/hc/en-us/articles/360048785512). 2. Access the Authorization tab within Postman. 3. Set the Authorization Type to **Basic Auth.** 4. Paste the API Token provided into the username field. Example Authorization Header: `Authorization: Basic YTFiYTAwMjEtMTRiZi00YWNmLThkYTQtNzVmYTVjMDllMjdi` This API Token will grant you access to our endpoints securely, ensuring the protection of your data and interactions. name: Authorization in: header security: - Authorization: [ ] tags: - name: Account description: '' - name: Action description: '' - name: AddressBook description: '' - name: Address description: '' - name: Auth description: '' - name: Batch description: '' - name: Capability description: '' - name: Catalog description: '' - name: Catalog V2 description: '' - name: Customer description: '' - name: Download description: '' - name: Editor description: '' - name: Editor V2 description: '' - name: HotFolder description: '' - name: InfigoOrderProduct description: '' - name: Job description: '' - name: MisExternalRef description: '' - name: Order description: '' - name: OrderlineItem description: '' - name: PrintLocation description: '' - name: ProductGroup description: '' - name: Quote description: '' - name: SSOCookie description: '' - name: SSOUrl description: '' - name: StorageFolder description: '' - name: Storefront description: '' - name: Thumbnail description: '' - name: UploadCSV description: '' - name: UploadLocation description: '' externalDocs: description: Infigo Academy url: https://www.youtube.com/@InfigoAcademy