gridList
Retrieve a list of grids.
Return Type: [Grid!]!
Arguments:
No arguments
gridRules
Retrieves all grid rules.
Return Type: [GridRule]
Arguments:
No arguments
searchGridRule
Searches for a grid rule by ID.
Return Type: GridRule
Arguments:
- id: String - The unique identifier of the grid rule to search for.
gridUploadPNGPreview
Upload PNG preview image for a grid.
Return Type: Grid!
Arguments:
- pngUrl: String! - URL of the PNG image to upload as grid preview.
gridManualPreview
Generate a manual grid preview with specified rows and columns.
Return Type: Grid!
Arguments:
- rows: Int! - Number of rows in the grid.
- columns: Int! - Number of columns in the grid.
gridAddNewCollage
Add a new collage grid with provided input.
Return Type: Grid!
Arguments:
gridUpdateCollage
Update an existing collage grid with provided input.
Return Type: Grid!
Arguments:
gridDelete
Delete a grid by id.
Return Type: GridResponse!
Arguments:
- id: String! - The unique identifier of the grid to delete.
gridRuleDelete
Deletes a grid rule by ID.
Return Type: GridRuleResponse
Arguments:
- id: String - The unique identifier of the grid rule to delete.
gridRuleUpdate
Updates an existing grid rule.
Return Type: GridRule
Arguments:
Grid
Represents a grid with design properties.
Fields:
- id: ID!
- gridID: Long! - Unique identifier of the grid.
- json: String - JSON data representing the grid.
- svg: String - SVG content for the grid design.
- name: String - Name of the grid.
- sellerID: Long - Identifier of the seller associated with the grid.
- isDeleted: Boolean! - Boolean flag indicating if the grid is marked as deleted.
GridResponse
GridResponse: Represents the response returned by the grid API endpoint.
Fields:
- result: String - The result of the grid operation.
GridRule
Represents a grid rule that defines mappings between grids and grid sides.
Fields:
- id: ID!
- gridRuleID: Long! - The unique identifier of the grid rule.
- name: String - The name of the grid rule.
- sellerID: Long! - The identifier of the seller associated with this grid rule.
- associations: [GridRuleGridSideMapping] - The list of grid-to-grid side mappings associated with the grid rule.
- grids: [Grid] - The list of grids used for JSON cache building.
GridRuleGridSideMapping
Represents a mapping between a grid rule and a grid side. Contains identifiers for grid rule, grid, product, and side.
Fields:
- gridRuleID: Long! - Identifier of the grid rule.
- gridID: Long! - Identifier of the grid.
- productID: Long - Optional identifier of the product.
- sideID: Long - Optional identifier of the side.
GridRuleResponse
Class representing the grid rule response.
Fields:
- result: String - The result of the grid rule execution.
Represents a grid input containing the grid ID, JSON representation, SVG content, and a name.
Properties:
- gridID: Long! - Unique identifier for the grid.
- json: String - JSON representation of the grid.
- svg: String - SVG representation of the grid.
- name: String - Name of the grid.
Represents a mapping input between a grid rule and a grid, optionally for a product or side, used in GraphQL operations.
Properties:
- gridRuleID: Long! - Identifier of the grid rule.
- gridID: Long! - Identifier of the grid.
- productID: Long - Optional identifier of the product.
- sideID: Long - Optional identifier of the side.
This class represents a grid rule input and contains grid rule properties, associations, and grids.
Properties:
- gridRuleID: Long - The unique identifier for the grid rule.
- name: String - The name of the grid rule.
- associations: [GridRuleGridSideMappingInput] - Collection of grid rule grid side mappings.
- grids: [GridInput!] - Collection of grids associated with the grid rule.