### Get Product by ID Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Get a product given an id. ```APIDOC ## GET /api/v1/products/{id} ### Description Get a product given an id. ### Method GET ### Endpoint /api/v1/products/{id} #### Path Parameters - **id** (string) - Required - The ID of the product ``` -------------------------------- ### Get Commissions Summary Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Gets a summary of commissions. ```APIDOC ## GET /api/v1/commissions/summary ### Description Gets a summary of commissions. ### Method GET ### Endpoint /api/v1/commissions/summary ``` -------------------------------- ### Products_Get_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Retrieves a specific product by its unique identifier. Use this endpoint to get detailed information about a single product. ```APIDOC ## GET /api/v1/products/{id} ### Description Get a product given an id. ### Method GET ### Endpoint /api/v1/products/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the product. ### Response #### Success Response (200) - (Product) - Returns the details of the requested product. ``` -------------------------------- ### Webhook Receiver Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Example of a webhook receiver endpoint. ```APIDOC ## POST /client/v1/webhook ### Description Example of webhook receiver endpoint. ### Method POST ### Endpoint /client/v1/webhook ``` -------------------------------- ### Get Revenue and Commissions Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Gets revenue and commissions information. ```APIDOC ## GET /api/v1/commissions/revenue-and-commissions ### Description Gets revenue and commissions information. ### Method GET ### Endpoint /api/v1/commissions/revenue-and-commissions ``` -------------------------------- ### Get Order Item by SKU Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Get an Order Item given a SKU. ```APIDOC ## GET /api/v1/skus/{sku} ### Description Get an Order Item given a SKU. ### Method GET ### Endpoint /api/v1/skus/{sku} #### Path Parameters - **sku** (string) - Required - The SKU of the order item ``` -------------------------------- ### Commissions_Summary Source: https://api.creativehub.io/swagger/v1/swagger.json Gets a summary of commissions. ```APIDOC ## GET /api/v1/commissions/summary ### Description Gets a summary of commissions. ### Method GET ### Endpoint /api/v1/commissions/summary ### Parameters #### Query Parameters - **from** (string) - Required - - **to** (string) - Required - - **clientManagerType** (string) - Required - ``` -------------------------------- ### Get Order by ID Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Get an order given an id. ```APIDOC ## GET /api/v1/orders/{id} ### Description Get an order given an id. ### Method GET ### Endpoint /api/v1/orders/{id} #### Path Parameters - **id** (string) - Required - The ID of the order ``` -------------------------------- ### Get Country by ID Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Get a country given an id. ```APIDOC ## GET /api/v1/countries/{id} ### Description Get a country given an id. ### Method GET ### Endpoint /api/v1/countries/{id} #### Path Parameters - **id** (string) - Required - The ID of the country ``` -------------------------------- ### Get Delivery Option by ID Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Get a delivery option given an id. ```APIDOC ## GET /api/v1/deliveryoptions/{id} ### Description Get a delivery option given an id. ### Method GET ### Endpoint /api/v1/deliveryoptions/{id} #### Path Parameters - **id** (string) - Required - The ID of the delivery option ``` -------------------------------- ### DeliveryOptions_Get_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Get a delivery option given an id. ```APIDOC ## GET /api/v1/deliveryoptions/{id} ### Description Retrieves a specific delivery option by its ID. ### Method GET ### Endpoint /api/v1/deliveryoptions/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the delivery option. ``` -------------------------------- ### Orders_Get_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Get an order given an id. ```APIDOC ## GET /api/v1/orders/{id} ### Description Get an order given an id. ### Method GET ### Endpoint /api/v1/orders/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - ### Response #### Success Response (200) - (OrderConfirmedResponse) - ``` -------------------------------- ### Countries_Get_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Get a country given an id. ```APIDOC ## GET /api/v1/countries/{id} ### Description Retrieves a specific country by its ID. ### Method GET ### Endpoint /api/v1/countries/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the country. ``` -------------------------------- ### Query Products Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Queries all your products. ```APIDOC ## POST /api/v1/products/query ### Description Queries all your products. ### Method POST ### Endpoint /api/v1/products/query ``` -------------------------------- ### Orders_Confirm_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Create a confirmed order. ```APIDOC ## POST /api/v1/orders/confirmed ### Description Create a confirmed order. ### Method POST ### Endpoint /api/v1/orders/confirmed ### Parameters #### Request Body - **model** (OrderConfirmedRequest) - Optional - ### Response #### Success Response (200) - (OrderConfirmedResponse) - ``` -------------------------------- ### DeliveryOptions_Query_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Queries all delivery options for all countries. ```APIDOC ## POST /api/v1/deliveryoptions/query ### Description Queries all available delivery options across all countries. ### Method POST ### Endpoint /api/v1/deliveryoptions/query ### Parameters #### Request Body - **request** (CollectionRequest) - Optional - The request object for querying delivery options. ``` -------------------------------- ### Products_Query_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Queries all products associated with your account. This endpoint allows you to retrieve a collection of products based on specified criteria. ```APIDOC ## POST /api/v1/products/query ### Description Queries all your products. ### Method POST ### Endpoint /api/v1/products/query ### Parameters #### Request Body - **request** (CollectionRequest) - Optional - The request object to specify query parameters for filtering products. ### Response #### Success Response (200) - (CollectionResultOfProduct) - Returns a collection of products matching the query criteria. ``` -------------------------------- ### Orders_Query_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Queries all your orders. ```APIDOC ## POST /api/v1/orders/query ### Description Queries all your orders. ### Method POST ### Endpoint /api/v1/orders/query ### Parameters #### Request Body - **request** (CollectionRequest) - Optional - ### Response #### Success Response (200) - (CollectionResultOfOrderConfirmedResponse) - ``` -------------------------------- ### Orders_Embryonic_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Create an embryonic order. ```APIDOC ## POST /api/v1/orders/embryonic ### Description Create an embryonic order. ### Method POST ### Endpoint /api/v1/orders/embryonic ### Parameters #### Request Body - **model** (OrderEmbryonicRequest) - Optional - ### Response #### Success Response (200) - (OrderEmbryonicResponse) - ``` -------------------------------- ### Create Embryonic Order Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Create an embryonic order. ```APIDOC ## POST /api/v1/orders/embryonic ### Description Create an embryonic order. ### Method POST ### Endpoint /api/v1/orders/embryonic ``` -------------------------------- ### Create Confirmed Order Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Create a confirmed order. ```APIDOC ## POST /api/v1/orders/confirmed ### Description Create a confirmed order. ### Method POST ### Endpoint /api/v1/orders/confirmed ``` -------------------------------- ### Query Delivery Options Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Queries all delivery options for all countries. ```APIDOC ## POST /api/v1/deliveryoptions/query ### Description Queries all delivery options for all countries. ### Method POST ### Endpoint /api/v1/deliveryoptions/query ``` -------------------------------- ### Query Orders Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Queries all your orders. ```APIDOC ## POST /api/v1/orders/query ### Description Queries all your orders. ### Method POST ### Endpoint /api/v1/orders/query ``` -------------------------------- ### Countries_Query_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Queries all the countries we deliver to. ```APIDOC ## POST /api/v1/countries/query ### Description Queries all countries that are available for delivery. ### Method POST ### Endpoint /api/v1/countries/query ### Parameters #### Request Body - **request** (CollectionRequest) - Optional - The request object for querying countries. ``` -------------------------------- ### Commissions_RevenueAndCommission Source: https://api.creativehub.io/swagger/v1/swagger.json Retrieves revenue and commission data. ```APIDOC ## GET /api/v1/commissions/revenue-and-commissions ### Description Retrieves revenue and commission data for a specified period and client manager type. ### Method GET ### Endpoint /api/v1/commissions/revenue-and-commissions ### Parameters #### Query Parameters - **from** (string) - Required - The start date for the data retrieval (date-time format). - **to** (string) - Required - The end date for the data retrieval (date-time format). - **clientManagerType** (string) - Optional - The type of client manager. ``` -------------------------------- ### RevenueAndCommissionsInfo Source: https://api.creativehub.io/swagger/v1/swagger.json Contains detailed information about revenue and commissions for a specific period. ```APIDOC ## RevenueAndCommissionsInfo ### Description This object holds the financial details for revenue and commissions over a specific month and year. ### Properties - **Year** (integer, required) - The year for which the revenue and commission data is recorded. - **Month** (integer, required) - The month for which the revenue and commission data is recorded. - **CommissionableRevenue** (number, required) - The amount of revenue that is eligible for commission. - **Commissions** (number, required) - The total amount of commissions calculated for the period. ``` -------------------------------- ### Webhook Definitions Source: https://api.creativehub.io/swagger/v1/swagger.json Defines the structure for various webhook events, including base properties and specific event payloads. ```APIDOC ## Webhook Definitions ### WebhookBase This is the base structure for all webhooks. #### Properties - **Version** (integer) - Required - The version of the webhook. - **ApiWebhookKind** (ApiWebhookKind) - Required - The type of webhook event. - **EventUtc** (string) - Required - The date and time the event occurred in UTC. - **Salt** (string) - Optional - A salt used for security purposes. ### ApiWebhookKind An enumeration representing the types of API webhooks. #### Enum Values - **Test**: A test webhook. - **OrderStateChanged**: A webhook for when an order's state changes. ### WebhookTest Represents a test webhook event. #### Properties - **Version** (integer) - Required - The version of the webhook. - **ApiWebhookKind** (ApiWebhookKind) - Required - Must be 'Test'. ### WebhookOrderStateChanged Represents a webhook event for when an order's state changes. #### Properties - **Version** (integer) - Required - The version of the webhook. - **ApiWebhookKind** (ApiWebhookKind) - Required - Must be 'OrderStateChanged'. ``` -------------------------------- ### Query Countries Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Queries all the countries we deliver to. ```APIDOC ## POST /api/v1/countries/query ### Description Queries all the countries we deliver to. ### Method POST ### Endpoint /api/v1/countries/query ``` -------------------------------- ### Data Structures Source: https://api.creativehub.io/swagger/v1/swagger.json Defines the data structures used within the API, including revenue, commission, client manager, and country information. ```APIDOC ## Data Structures ### RevenueAndCommissionsInfo Contains information about revenue and commissions for a specific period. #### Properties - **Year** (integer) - The year. - **Month** (Month) - The month. - **CommissionableRevenue** (decimal) - The commissionable revenue. - **Commissions** (decimal) - The commissions. ### ClientManagerInfo Information about a client manager. #### Properties - **SalesRepGroup** (ClientManagerGroup) - Required - The sales representative group. - **SalesRepFullName** (string) - The full name of the sales representative. - **SalesRepEmail** (string) - The email address of the sales representative. - **RevenueAndCommissionsGroups** (array) - A list of revenue and commissions groups associated with the client manager. - **items**: (RevenueAndCommissionsGroup) ### ClientManagerGroup An enumeration representing client manager groups. #### Enum Values - **InHouse** (1) - **AgencyMember** (2) - **ExAgencyMember** (3) - **AccountHandlersMember** (4) - **ExAccountHandlersMember** (5) ### RevenueAndCommissionsGroup Details about a group of revenue and commissions. #### Properties - **CommissionRateKind** (CommissionRateKind) - Required - The kind of commission rate. - **CommissionRate** (decimal) - Required - The commission rate. - **RevenueAndCommissionsInfo** (array) - A list of revenue and commissions information. - **items**: (RevenueAndCommissionsInfo) ### CommissionRateKind An enumeration representing the kinds of commission rates. #### Enum Values - **SpecialRate** (1) - **HighRate** (2) - **LowRate** (3) - **NoRate** (4) - **TransferredRate** (5) - **AccountHandlerRate** (6) ### CollectionResultOfCountry Represents a collection of countries with total count. #### Properties - **Data** (array) - A list of countries. - **items**: (Country) - **Total** (integer) - The total number of countries. ### Country Represents a country. #### Properties - **Id** (integer) - Required - The unique identifier for the country. - **Code** (string) - The country code. - **Name** (string) - The name of the country. ### CollectionResultOfDeliveryOption Represents a collection of delivery options with total count. #### Properties - **Data** (array) - A list of delivery options. - **items**: (DeliveryOption) - **Total** (integer) - The total number of delivery options. ``` -------------------------------- ### Update Order State (Test Only) Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Only for test deployments, not for production use - update an order's state. ```APIDOC ## PUT /api/v1/orders/state ### Description Only for test deployments, not for production use - update an order's state. ### Method PUT ### Endpoint /api/v1/orders/state ``` -------------------------------- ### OrderStateRequest Source: https://api.creativehub.io/swagger/v1/swagger.json Represents a request to update the state of an order. ```APIDOC ## OrderStateRequest ### Description This object is used to update the state of an existing order. ### Properties - **OrderId** (integer, required) - The unique identifier for the order. - **OrderState** (OrderState, required) - The new state to be assigned to the order. Refer to the OrderState definition for allowed values. ``` -------------------------------- ### OrderConfirmedRequest Source: https://api.creativehub.io/swagger/v1/swagger.json Represents a request to confirm an order, including delivery details and charges. ```APIDOC ## OrderConfirmedRequest ### Description This object is used to confirm an order, specifying the order ID, selected delivery option, and associated delivery charges. ### Properties - **OrderId** (integer, required) - The unique identifier for the order. - **DeliveryOptionId** (integer, required) - The identifier for the chosen delivery option. - **DeliveryChargeExcludingSalesTax** (number, required) - The cost of delivery before sales tax. - **DeliveryChargeSalesTax** (number, required) - The amount of sales tax applied to the delivery charge. - **ExternalReference** (string, optional) - An external reference identifier for the order confirmation. ``` -------------------------------- ### SummaryRevenueItemValue Source: https://api.creativehub.io/swagger/v1/swagger.json Represents a value for a summary revenue item, including its type and kind. ```APIDOC ## SummaryRevenueItemValue ### Description This object defines the value of a revenue item within a summary, specifying its type and category. ### Properties - **SummaryRevenueItemValueType** (SummaryRevenueItemValueType, required) - The type of the revenue item (e.g., TypeOfRevenue, SpecialAccount). - **Kind** (SummaryRevenueItemKind, required) - The specific kind or category of the revenue item (e.g., FrenzyRevenueType1, HouseClients). - **RevenueAndCommissionsInfo** (array[RevenueAndCommissionsInfo], optional) - A list of revenue and commission details for the item. ``` -------------------------------- ### Orders_Delete_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Cancel an embryonic order. ```APIDOC ## DELETE /api/v1/orders/{id} ### Description Cancel an embryonic order. ### Method DELETE ### Endpoint /api/v1/orders/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - ### Response #### Success Response (204) - ``` -------------------------------- ### WebhookClient_Webhook_v1 Source: https://api.creativehub.io/swagger/v1/swagger.json Receives webhook events from the CreativeHub platform. This endpoint is designed to be called by the CreativeHub system to send notifications. ```APIDOC ## POST /client/v1/webhook ### Description Receives webhook events from the CreativeHub platform. ### Method POST ### Endpoint /client/v1/webhook ### Parameters #### Request Body - **payload** (WebhookBase) - Optional - The webhook payload containing event details. ### Response #### Success Response (200) - (file) - The response may contain a file, but its structure is not detailed. ``` -------------------------------- ### Cancel Order Source: https://api.creativehub.io/swagger/index.html?url=%2Fswagger%2Fv1%2Fswagger.json Cancel an embryonic order. ```APIDOC ## DELETE /api/v1/orders/{id} ### Description Cancel an embryonic order. ### Method DELETE ### Endpoint /api/v1/orders/{id} #### Path Parameters - **id** (string) - Required - The ID of the order to cancel ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.