Return Types

This section lists the return types that the API uses. Every endpoint describes which type it returns.

Field Descriptions

Key: The key for the value in question in the JSON object.
Description: What the value represents.
Type: Either a type, or a reference to a specific return type.
Expanding: Expanding fields contain data related to the parent entity. They are not present in the result by default, but can be added on as specified in the endpoint’s documentation.

ApplicationInstanceInfos

Represents a status for an application instance.

Fields

Key	Description	Type	Expanding
`nickname`	Nickname.	`string`	No
`status`	The current status.	`ApplicationInstanceStatuses`	Yes

ApplicationInstancePreferenceValues

An application instance preference resolved to its effective value, keyed by its code.

Fields

Key	Description	Type	Expanding
`code`	The preference code.	`string`	No
`value`	The value.	`string`	No
`modified`	Last modified date.	`date`	No

ApplicationInstancePreferences

Represents an application instance preference.

Fields

Key	Description	Type	Expanding
`value`	The value.	`string`	No
`modified`	Last modified date.	`date`	No

ApplicationInstanceStatuses

Represents a status for an application instance.

Fields

Key	Description	Type	Expanding
`name`	Name of the status.	`string`	No
`code`	Internal code of the status.	`string`	No
`description`	Description.	`string`	No

Auth

Fields

Key	Description	Type	Expanding
`session_token`	Session token to pass into API calls.	`string`	No
`expiry`	Session expiry time.	`date`	No

Brands

Brand data.

Fields

Key	Description	Type	Expanding
`id`	ID of the brand.	`number`	No
`name`	Name of the brand.	`string`	No

BulkAdjustVirtualStockResult

Holds data about the results of a bulk virtual stock adjustment.

Fields

Key	Description	Type	Expanding
`affected`	The number of items affected by the bulk action.	`number`	No

BulkCheckOrderExists

Check if an order reference already exists on a channel.

Fields

Key	Description	Type	Expanding
`order_reference`	Order reference.	`string`	No
`order_id`	BladePRO Order Id.	`number`	No
`exists`	Does the order exists.	`boolean`	No

BulkImportOrdersFile

Confirmation of a file upload.

Fields

Key	Description	Type	Expanding
`success`	Pass an order export to import orders in bulk.	`boolean`	No

BulkListAllOpenOrders

List all the ‘open’ orders for a given channel. Can be used to do a pre-cursive check for order importer functions to filter out orders have been previously imported.

Fields

Key	Description	Type	Expanding
`order_id`	Order id.	`number`	No
`reference`	Order reference.	`string`	No
`goodsouts`	List of related goodsouts.	`array<BulkListAllOpenOrdersGoodsout>`	Yes

BulkListAllOpenOrdersGoodsout

Fields

Key	Description	Type	Expanding
`order_goodsout_id`	Order Goodsout id.	`string`	No
`status`	Goodsout status.	`string`	No
`metadata`	List of related metadata created by this app instance.	`array<BulkListAllOpenOrdersGoodsoutMetadata>`	Yes

BulkListAllOpenOrdersGoodsoutMetadata

Fields

Key	Description	Type	Expanding
`key`	Metadata Key.	`string`	No
`value`	Metadata Value.	`string`	No

BulkOrderStatuses

Defines a status against an order goodsout.

Fields

Key	Description	Type	Expanding
`order_goodsout_id`	Order goodsout ID.	`number`	No
`status`	List of tracking numbers.	`enum` * see below	No

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`

BulkOrderTrackingNumbers

Defines a list of tracking numbers against an order goodsout.

Fields

Key	Description	Type	Expanding
`order_goodsout_id`	Order goodsout ID.	`number`	No
`despatch_date`	Despatch date.	`date`	No
`courier`	Courier name.	`string`	No
`external_tracking_enabled`	Trackable flag.	`boolean`	No
`service`	Shipping service name.	`string`	No
`tracking_numbers`	List of tracking numbers.	`array<CachedCourierTracking>`	Yes

BulkOrderTrackingNumbersByReference

Defines a list of tracking numbers against an order goodsout.

Fields

Key	Description	Type	Expanding
`reference`	Order reference.	`string`	No
`order_goodsout_id`	Order goodsout ID.	`number`	No
`despatch_date`	Despatch date.	`date`	No
`status`	Goodsout status.	`enum` * see below	No
`courier`	Courier name.	`string`	No
`service`	Shipping service name.	`string`	No
`external_tracking_enabled`	Trackable flag.	`boolean`	No
`tracking_numbers`	List of tracking numbers.	`array<CachedCourierTracking>`	Yes

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`

CachedAddress

An address.

Fields

Key	Description	Type	Expanding
`first_name`	First name.	`string`	No
`last_name`	Last name.	`string`	No
`company`	Company name.	`string`	No
`address_one`	Address line one.	`string`	No
`address_two`	Address line two.	`string`	No
`address_three`	Address line three.	`string`	No
`town`	Town.	`string`	No
`county`	County or state.	`string`	No
`postcode`	Postcode.	`string`	No
`email`	Email address.	`string`	No
`mobile`	Mobile telephone.	`string`	No
`telephone`	Telephone.	`string`	No
`secondary_telephone`	Secondary telephone.	`string`	No
`contact`	BladePRO contact data.	`CachedAddressContact`	Yes
`country`	Country.	`SummarisedCountry`	Yes

CachedAddressContact

A BladePRO contact.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`group`	Group name.	`string`	No

CachedApplicationMarketplaceAttribute

Marketplace attribute

Fields

Key	Description	Type	Expanding
`id`	Attribute definition id.	`number`	No
`name`	Name of the attribute.	`string`	No
`description`	Description of the attribute.	`string`	No
`code`	Code representing the attribute.	`string`	No

CachedAttribute

An attribute.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`value`	Value.	`string`	No

CachedBrand

A brand.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No

CachedCourier

A courier.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`code`	Code.	`string`	No
`service`	Service details.	`CachedShippingService`	Yes
`tracking`	Tracking details.	`array<CachedCourierTracking>`	Yes

CachedCourierTracking

Tracking details.

Fields

Key	Description	Type	Expanding
`courier`	Courier name.	`string`	No
`code`	The tracking number.	`string`	No
`url`	Tracking URL.	`string`	No

CachedGoodsout

An order goodsout.

Fields

Key	Description	Type	Expanding
`id`	Goodsout ID.	`number`	No
`bid`	Full BladePRO ID.	`string`	No
`creator`	Who created the goodsout.	`string`	No
`status`	Goodsout status.	`enum` * see below	No
`date_placed`	Placed date.	`date`	No
`despatch_date`	Despatch date.	`date`	No
`despatch_on_date`	Despatch on date.	`date`	No
`type`	Goodsout type, as set when the goodsout was created.	`enum` * see below	No
`retailer_id`	ID of the retailer the goodsout is destined for. Null when the goodsout has no retailer.	`number`	No
`warehouse`	Fulfilment warehouse.	`SummarisedWarehouse`	Yes
`courier`	Courier.	`CachedCourier`	Yes
`tags`	List of applied tags.	`array<SummarisedTag>`	Yes
`attributes`	List of applied attributes.	`array<CachedAttribute>`	Yes
`shipping_address`	The shipping address.	`CachedAddress`	Yes
`order`	The parent order.	`CachedOrder`	Yes
`lines`	Summaries of the active goodsout lines that describe products. No extras or packaging are listed.	`array<CachedGoodsoutLine>`	Yes

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`
`type`	`consumer`, `trade`, `retail`

CachedGoodsoutLine

An order goodsout line summary.

Fields

Key	Description	Type	Expanding
`id`	ID of the line.	`number`	No
`product_variation_id`	ID of the product variation.	`number`	No
`sku`	SKU of the product variation.	`string`	No
`name`	English description of the product variation.	`string`	No
`quantity`	Ordered quantity.	`number`	No

CachedMarketplaceListing

Marketplace listing

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing variation ID.	`number`	No
`marketplace_reference`	The marketplace reference of the listing variation.	`string`	No
`attributes`	Listing attributes.	`array<CachedMarketplaceListingAttribute>`	Yes
`options`	Listing option definitions.	`array<CachedMarketplaceListingOption>`	Yes
`images`	Variation images.	`array<CachedMarketplaceListingImage>`	Yes
`related_listing_variations`	Related listing variations that belong to the same parent marketplace_listing	`array<CachedMarketplaceListingVariationRelatedVariation>`	Yes

CachedMarketplaceListingAttribute

Marketplace listing attributes

Fields

Key	Description	Type	Expanding
`label_json`	JSON string defining the label of the attribute value.	`string`	No
`value`	The attribute value.	`string`	No
`attribute`	The attribute definition.	`CachedApplicationMarketplaceAttribute`	Yes

CachedMarketplaceListingImage

Marketplace listing variation images

Fields

Key	Description	Type	Expanding
`primary`	Id this the primary image for the listing .	`boolean`	No
`sequence`	The ordered sequence for this image.	`number`	No
`url`	The url to access this image.	`string`	No

CachedMarketplaceListingOption

Marketplace listing option definition.

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing option ID.	`number`	No
`name`	The name of the option.	`string`	No

CachedMarketplaceListingVariation

Marketplace listing summary

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing variation ID.	`number`	No
`marketplace_listing_id`	The parent marketplace listing ID.	`number`	No
`marketplace_reference`	The marketplace reference of the listing variation.	`string`	No
`sku`	The listed SKU.	`string`	No
`price`	The listed Price.	`number`	No
`status`	The status of the listing.	`enum` * see below	No
`listing_mode`	The listing mode of the listing.	`enum` * see below	No
`stock_mode`	The stock mode of the listing.	`enum` * see below	No
`marketplace_listing`	The parent listing.	`CachedMarketplaceListing`	Yes
`product_variation`	The related product variation.	`CachedMarketplaceListingVariationProductVariation`	Yes
`attributes`	Variation attributes.	`array<CachedMarketplaceListingVariationAttribute>`	Yes
`options`	Variation options.	`array<CachedMarketplaceListingVariationOption>`	Yes
`images`	Variation images.	`array<CachedMarketplaceListingVariationImage>`	Yes

Enums

Field	Values
`status`	`draft`, `live`, `void`
`listing_mode`	`keep_in_sync`, `do_not_sync`
`stock_mode`	`keep_in_sync`, `do_not_sync`, `always_in_stock`, `never_in_stock`

CachedMarketplaceListingVariationAttribute

Marketplace listing variation attributes

Fields

Key	Description	Type	Expanding
`label_json`	JSON string defining the label of the attribute value.	`string`	No
`value`	The attribute value.	`string`	No
`attribute`	The attribute definition.	`CachedApplicationMarketplaceAttribute`	Yes

CachedMarketplaceListingVariationImage

Marketplace listing variation images

Fields

Key	Description	Type	Expanding
`primary`	Id this the primary image for the listing variation.	`boolean`	No
`sequence`	The ordered sequence for this image.	`number`	No
`url`	The url to access this image.	`string`	No

CachedMarketplaceListingVariationOption

Value for a marketplace listing option.

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing variation option ID.	`number`	No
`marketplace_listing_option_id`	The owning marketplace listing option ID.	`number`	No
`value`	The value of the option.	`string`	No
`option`	The option type.	`CachedMarketplaceListingOption`	Yes

CachedMarketplaceListingVariationProductVariation

Marketplace listing variation attributes

Fields

Key	Description	Type	Expanding
`id`	The product variations’s ID.	`number`	No
`sku`	The product’s SKU.	`string`	No
`aspects`	Marketplace application aspects.	`array<CachedMarketplaceListingVariationProductVariationAspects>`	Yes
`category`	The product’s category.	`CachedMarketplaceListingVariationProductVariationCategory`	Yes

CachedMarketplaceListingVariationProductVariationAspects

Marketplace listing variation aspects

Fields

Key	Description	Type	Expanding
`value`	The aspect value.	`string`	No
`label`	The aspects label.	`string`	No
`aspect`	The attribute definition.	`CachedApplicationMarketplaceAttribute`	Yes

CachedMarketplaceListingVariationProductVariationCategory

Marketplace listing variation category

Fields

Key	Description	Type	Expanding
`id`	The category id.	`number`	No
`name`	The category name.	`string`	No
`preferences`	Marketplace application aspects.	`array<CachedMarketplaceListingVariationProductVariationCategoryPreferences>`	Yes

CachedMarketplaceListingVariationProductVariationCategoryPreferences

Marketplace listing variation category preferences

Fields

Key	Description	Type	Expanding
`value`	The preference value.	`string`	No
`label`	The preference label.	`string`	No
`preference`	The preference definition.	`CachedMarketplaceListingVariationProductVariationCategoryPreferencesPreference`	Yes

CachedMarketplaceListingVariationProductVariationCategoryPreferencesPreference

Marketplace listing variation aspects

Fields

Key	Description	Type	Expanding
`name`	The preference name.	`string`	No
`code`	The preference short code reference.	`string`	No

CachedMarketplaceListingVariationRelatedVariation

Related listing variations that belong to the same parent marketplace_listing

Fields

Key	Description	Type	Expanding
`id`	The listing variation id.	`number`	No
`marketplace_reference`	The listing variation marketplace reference.	`string`	No
`status`	The BladePRO status for the listing variation.	`string`	No
`sku`	The listing variations listed sku.	`string`	No

CachedNameAndCode

Holds a name and a code field.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`code`	Code.	`string`	No

CachedOrder

An order.

Fields

Key	Description	Type	Expanding
`id`	Order ID.	`number`	No
`reference`	Unique reference.	`string`	No
`status`	Order status.	`enum` * see below	No
`channel`	Order channel.	`CachedOrderChannel`	Yes
`currency`	Currency.	`SummarisedCurrency`	Yes
`brand`	Brand.	`CachedBrand`	Yes

Enums

Field	Values
`status`	`draft`, `open`, `complete`, `cancelled`

CachedOrderChannel

An order channel.

Fields

Key	Description	Type	Expanding
`id`	Id.	`number`	No
`short_code`	Code.	`string`	No
`name`	Name.	`string`	No

CachedProduct

Top level product data.

Fields

Key	Description	Type	Expanding
`id`	The product id.	`number`	No
`channel`	The product channel.	`CachedProductChannel`	Yes

CachedProductChannel

Cached product channel.

Fields

Key	Description	Type	Expanding
`id`	The product channel id.	`number`	No
`name`	Product channel name.	`string`	No
`default_warehouse_id`	Default warehouse id.	`number`	No
`global`	Is it a global shared product.	`boolean`	No
`organisation`	Organisation that the product channel belongs to.	`CachedProductChannelOrganisation`	Yes

CachedProductChannelOrganisation

Top level product data.

Fields

Key	Description	Type	Expanding
`id`	Organisation id.	`number`	No
`name`	Organisation name.	`string`	No

CachedProductVariation

Variation specific data.

Fields

Key	Description	Type	Expanding
`id`	The product variation id.	`number`	No
`sku`	The product SKU.	`string`	No
`name`	The product name.	`string`	No
`is_primary`	Is this a primary product.	`boolean`	No
`status`	The status of the product.	`enum` * see below	No
`created`	The created date.	`CachedProductVariationCreated`	Yes
`product`	Parent product.	`CachedProduct`	Yes
`tags`	List of applied tags.	`array<SummarisedTag>`	Yes
`descriptions`	List of descriptions.	`array<CachedProductVariationDescription>`	Yes
`components`	List of components.	`array<CachedProductVariationComponent>`	Yes
`type`	The product type.	`SummarisedProductVariationType`	Yes
`primary_product_category`	The primary product category.	`SummarisedProductCategory`	Yes

Enums

Field	Values
`status`	`active`, `draft`, `discontinued`

CachedProductVariationComponent

Variation component.

Fields

Key	Description	Type	Expanding
`id`	The product component id.	`number`	No
`sku`	The component SKU.	`string`	No
`name`	The component name.	`string`	No
`barcode`	The component barcode.	`string`	No
`quantity`	The quantity of this component used in the product variation.	`number`	No

CachedProductVariationCreated

Variation specific data.

Fields

Key	Description	Type	Expanding
`date`	Date string.	`string`	No
`timezone`	Timezone.	`string`	No

CachedProductVariationDescription

Variation descriptions.

Fields

Key	Description	Type	Expanding
`id`	The product variation id.	`number`	No
`product_variation_id`	The product variation id.	`number`	No
`locale_id`	The description locale.	`number`	No
`name`	The product name.	`string`	No
`full_description`	The description of the product.	`string`	No
`created`	The created date.	`date`	No
`modified`	The last modified date.	`date`	No
`locale`	The locale for this description.	`SummarisedLocale`	No

CachedShippingService

Holds data about a shipping service.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`code`	Code.	`string`	No
`tracked`	Whether this service is tracked.	`boolean`	No
`signed`	Wheter this service requires signing by the recipient.	`boolean`	No

CartonLabelTypeReferences

References for carton label types.

Fields

Key	Description	Type	Expanding
`name`	Descriptive name of the reference.	`string`	No
`code`	The code the reference can be addressed by.	`string`	No
`type`	Type of the reference.	`enum` * see below	No
`validation_pattern`	Regular expression used to validate the value.	`string`	No

Enums

Field	Values
`type`	`text`, `barcode`

CartonLabelTypes

Carton label types data.

Fields

Key	Description	Type	Expanding
`id`	ID of the carton label type.	`number`	No
`name`	Descriptive name of the carton label type.	`string`	No
`active`	If the carton label type is active.	`number`	No
`carton_label_type_references`	References of the carton label type.	`array<CartonLabelTypeReferences>`	Yes

ConfirmBooking

Confirm booking.

Fields

Key	Description	Type	Expanding
`purchase_order_id`	ID of the purchase order.	`number`	No
`goods_in_id`	ID of the associated goods-in booking.	`number`	No
`expected_date`	Expected booking date in ISO format (YYYY-MM-DD).	`string`	No
`expected_time_slot`	Expected booking time slot.	`string`	No

ConsignmentQualities

Consignment quality description.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`group`	Quality group.	`string`	No
`description`	Details.	`string`	No
`active`	Is it active?	`boolean`	No

Countries

A country.

Fields

Key	Description	Type	Expanding
`id`	The country’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`iso_2`	ISO2 description.	`string`	No
`iso_3`	ISO3 description.	`string`	No
`region_id`	ID of the region.	`number`	No
`currency_id`	ID of the country’s currency.	`number`	No
`block`	Trade block.	`enum` * see below	No
`region`	The region.	`Regions`	Yes
`currency`	The country’s currency.	`Currencies`	Yes

Enums

Field	Values
`block`	`EU`

Currencies

Currency data.

Fields

Key	Description	Type	Expanding
`id`	ID of the currency.	`number`	No
`code`	ISO code of the currency.	`string`	No
`name`	Descriptive name of the currency.	`string`	No
`symbol`	Symbol to render next to values.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

DemandPlanningApplicationInstanceSettings

Stores data about the current application instance.

Fields

Key	Description	Type	Expanding
`product_channel_id`	Product channel ID.	`number`	No
`organisation_id`	Organisation ID.	`number`	No
`warehouse_code`	Warehouse short code.	`string`	No

DespatchedOrders

An order goodsout.

Fields

Key	Description	Type	Expanding
`id`	Goodsout ID.	`number`	No
`status`	Status.	`string`	No
`bid`	BID.	`string`	No
`despatch_date`	Despatch date.	`date`	No
`courier`	Courier.	`CachedCourier`	Yes
`attributes`	List of applied attributes.	`array<CachedAttribute>`	Yes
`order`	The parent order.	`CachedOrder`	Yes

Fields

Importer Mapping Fields

Fields

Key	Description	Type	Expanding
`source`	Source field name.	`string`	No
`destination`	Destination field name.	`string`	No
`default_value`	Default Value	`string`	No
`manipulations`	Manipulations	`object`	No
`default_format`	Default Format	`string`	No
`value_replacements`	Value Replacements	`object`	No

Fields

Key	Description	Type	Expanding
`id`	The concern id representing this GDPR request.	`string`	No

ImportMarketplaceListing

Import marketplace listing

Fields

Key	Description	Type	Expanding
`id`	The ID of the listing.	`number`	No
`marketplace_reference`	The marketplace reference.	`string`	No
`product_category_id`	The ID of the product category.	`number`	No
`marketplace_listing_variations`	List of marketplace listing variations.	`array<ImportMarketplaceListingVariation>`	Yes
`options`	List of options created for the listing.	`array<ImportMarketplaceListingOption>`	Yes

ImportMarketplaceListingOption

A marketplace listing option during import.

Fields

Key	Description	Type	Expanding
`id`	The ID of the option.	`number`	No
`name`	The name of the option.	`string`	No

ImportMarketplaceListingVariation

A marketplace listing variation during import.

Fields

Key	Description	Type	Expanding
`id`	The ID of the listing variation.	`number`	No
`title`	The title of the listing.	`string`	No
`subtitle`	The subtitle of the listing.	`string`	No
`description`	The subtitle of the listing.	`string`	No
`listing_mode`	The listing mode of the listing variation.	`enum` * see below	No
`stock_mode`	The stock mode of the listing variation.	`enum` * see below	No
`marketplace_reference`	The marketplace reference.	`string`	No
`price`	The marketplace price of the product.	`number`	No
`product_variation_id`	The product variation the listing is linked to.	`number`	No
`quantity`	Current marketplace stock level.	`number`	No
`sku`	Current marketplace SKU.	`string`	No
`status`	The status of the listing variation.	`enum` * see below	No
`options`	List of options created for the variation.	`array<ImportMarketplaceListingVariationOption>`	Yes

Enums

Field	Values
`listing_mode`	`keep_in_sync`, `do_not_sync`
`stock_mode`	`keep_in_sync`, `do_not_sync`, `always_in_stock`, `never_in_stock`
`status`	`draft`, `live`, `void`, `pending_live`, `pending_void`

ImportMarketplaceListingVariationOption

A marketplace listing variation option during import.

Fields

Key	Description	Type	Expanding
`id`	The ID of the variation option.	`number`	No
`marketplace_listing_option_id`	The ID of the marketplace listing option.	`number`	No
`value`	The value of the option.	`string`	No

Incident

Represents the result of logging an incident request.

Fields

Key	Description	Type	Expanding
`incident_id`	The related incident’s ID, if applicable.	`number`	No

Locales

Locale data.

Fields

Key	Description	Type	Expanding
`id`	ID of the locale.	`number`	No
`name`	Name of the locale.	`string`	No
`code`	Unique short code of the locale.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

Log

Represents the result of a logging request.

Fields

Key	Description	Type	Expanding
`success`	Holds true if the log entry was saved successfully.	`boolean`	No

Mappings

File Mapping data.

Fields

Key	Description	Type	Expanding
`id`	ID of the mapping.	`number`	No
`slug`	Slug of the mapping.	`string`	No
`name`	Name of the mapping.	`string`	No
`organisation_id`	Organisation ID.	`number`	No
`fields`	Mappings Fields	`Fields`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

MarketplaceApplicationInstanceSettings

Stores data about the current application instance.

Fields

Key	Description	Type	Expanding
`currency_id`	Currency ID.	`number`	No
`locale_id`	Locale ID.	`number`	No
`order_channel_id`	Order channel ID.	`number`	No
`primary_warehouse_id`	Primary warehouse’s ID.	`number`	No
`order_import_grace_period_minutes`	Grace period in minutes for ignoring orders.	`number`	No
`ignore_orders_created_before`	Ignore orders created before a certain date.	`date`	No
`allow_multi_location_support`	Is the multi location support enabled for this integration.	`boolean`	No
`currency`	Currency.	`SummarisedCurrency`	Yes
`locale`	Locale.	`SummarisedLocale`	Yes
`order_channel`	Order channel.	`OrderChannels`	Yes
`primary_warehouse`	Primary warehouse.	`SummarisedWarehouse`	Yes
`warehouses`	Configured warehouses for this specific integration.	`array<SummarisedWarehouse>`	Yes

MarketplaceListingBulkUpdateQuantities

Marketplace listing bulk update listed quantity

Fields

Key	Description	Type	Expanding
`success`	Was the bulk update successful.	`boolean`	No

MarketplaceListingCostPrice

Marketplace listing cost price

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing ID.	`number`	No
`marketplace_reference`	The marketplace reference of the listing.	`string`	No
`resource_metadatas`	List of metadata keys and values set against the listing.	`array<MarketplaceListingResourceMetadatas>`	Yes
`variations`	List of marketplace listing variations	`array<MarketplaceListingVariationCostPrice>`	Yes

MarketplaceListingPurge

Marketplace listing purge

Fields

Key	Description	Type	Expanding
`success`	Was the purge update successful.	`boolean`	No

MarketplaceListingResourceMetadatas

Stores arbitrary data against a marketplace listing.

Fields

Key	Description	Type	Expanding
`key`	Key the piece of stored metadata is identified with.	`string`	No
`value`	Stored data metadata.	`string`	No

MarketplaceListingStock

Marketplace listing stock

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing ID.	`number`	No
`marketplace_reference`	The marketplace reference of the listing.	`string`	No
`resource_metadatas`	List of metadata keys and values set against the listing.	`array<MarketplaceListingResourceMetadatas>`	Yes
`variations`	List of marketplace listing variations	`array<MarketplaceListingVariationStock>`	Yes

MarketplaceListingTemplates

Marketplace listing templates

Fields

Key	Description	Type	Expanding
`marketplace_listing_variation_id`	ID of the marketplace listing variation.	`number`	No
`locale`	The locale of the template.	`string`	No
`title`	Rendered titles by locale.	`object`	No
`subtitle`	Rendered subtitles by locale.	`object`	No
`description`	Rendered descriptions by locale.	`object`	No

MarketplaceListingUpdateAttributes

Marketplace attribute

Fields

Key	Description	Type	Expanding
`code`	The attribute code.	`string`	No
`name`	The attribute name.	`string`	No
`value`	The value of the attribute.	`string`	No

MarketplaceListingUpdateListingVariations

Marketplace listing updates

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing variation id.	`number`	No
`marketplace_reference`	The marketplace reference.	`string`	No
`sku`	The listed SKU.	`string`	No
`price`	The currently listed price.	`number`	No
`status`	The status of the listing variation.	`string`	No
`attributes`	Variation attributes.	`array<MarketplaceListingUpdateAttributes>`	Yes

MarketplaceListingUpdateListings

Marketplace listing updates

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing id.	`number`	No
`marketplace_reference`	The marketplace reference.	`string`	No
`attributes`	Listing attributes.	`array<MarketplaceListingUpdateAttributes>`	Yes

MarketplaceListingUpdates

Marketplace listing updates

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing update ID.	`number`	No
`code`	The update type code.	`string`	No
`listing_id`	The marketplace listing ID.	`number`	No
`variation_id`	The marketplace variation ID.	`number`	No
`old_value`	The old value of the updated field.	`string`	No
`new_value`	The new value of the updated field.	`string`	No
`status`	The marketplace listing update status.	`enum` * see below	No
`claim_reference`	The reference ID of the claimed batch.	`string`	No
`claimed`	Claimed date.	`number`	No
`created`	Created date.	`date`	No
`marketplace_listing`	The related listing.	`MarketplaceListingUpdateListings`	Yes
`marketplace_listing_variation`	The related listing variation ( if applicable ) .	`MarketplaceListingUpdateListingVariations`	Yes

Enums

Field	Values
`status`	`pending`, `cancelled`, `updating`, `completed`, `failed`

MarketplaceListingVariation

Marketplace listing

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing variation ID.	`number`	No
`marketplace_reference`	The reference assigned by the 3rd part marketplace.	`string`	No
`price`	The current listed price.	`number`	No
`status`	The listing variation status.	`string`	No
`sku`	The listed sku.	`string`	No
`product_variation_id`	The linked product variation id.	`number`	No
`quantity`	The currently listed quantity.	`number`	No
`created`	Created date.	`date`	No

MarketplaceListingVariationCostPrice

Marketplace listing variation cost price

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing variation ID.	`number`	No
`marketplace_reference`	The marketplace reference of the product variation.	`string`	No
`sku`	The product SKU.	`string`	No
`product_variation_id`	The product variation ID.	`number`	No
`cost_price`	The average cost price.	`number`	No
`resource_metadatas`	List of metadata keys and values set against the listing variation.	`array<MarketplaceListingVariationResourceMetadatas>`	Yes

MarketplaceListingVariationResourceMetadatas

Stores arbitrary data against a marketplace listing variation.

Fields

Key	Description	Type	Expanding
`key`	Key the piece of stored metadata is identified with.	`string`	No
`value`	Stored data metadata.	`string`	No

MarketplaceListingVariationStock

Marketplace listing variation stock

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing variation ID.	`number`	No
`marketplace_reference`	The marketplace reference of the product variation.	`string`	No
`sku`	The product SKU.	`string`	No
`product_variation_id`	The product variation ID.	`number`	No
`current_listed_quantity`	What quantity BladePRO think is currently listed.	`number`	No
`quantity_to_list`	What quantity BladePRO thinks should be listed.	`number`	No
`resource_metadatas`	List of metadata keys and values set against the listing variation.	`array<MarketplaceListingVariationResourceMetadatas>`	Yes
`marketplace_locations`	List of locations if multi location is enabled.	`array<MarketplaceListingVariationStockMarketplaceLocations>`	Yes

MarketplaceListingVariationStockMarketplaceLocations

Marketplace listing variation’s location-based stock

Fields

Key	Description	Type	Expanding
`marketplace_location_id`	ID of the location from the app’s global linking.	`number`	No
`current_listed_quantity`	What quantity BladePRO think is currently listed.	`number`	No
`quantity_to_list`	What quantity BladePRO thinks should be listed.	`number`	No

MarketplaceListings

Marketplace listing

Fields

Key	Description	Type	Expanding
`id`	The marketplace listing ID.	`number`	No
`marketplace_reference`	The reference assigned by the 3rd part marketplace.	`string`	No
`created`	Created date.	`date`	No

MarketplaceLocations

Acts as a link between BladePRO warehouses and marketplace locations.

Fields

Key	Description	Type	Expanding
`id`	BladePRO ID for the location mapping.	`number`	No
`despatch_warehouse_id`	ID of the warehouse the items need to be despatched from.	`number`	No
`location_name`	User-defined, friendly name for the mapping.	`string`	No
`location_key`	Identifier from the marketplace.	`string`	No
`location_extra`	Extra arbitrary data stored for this location mapping.	`string`	No
`default_stock_mode`	The default stock mode to use when importing a new listing for this location only.	`enum` * see below	No
`despatch_warehouse`	The despatch warehouse.	`Warehouses`	Yes
`stock_warehouses`	List of warehouses stock need to be used from.	`array<Warehouses>`	Yes

Enums

Field	Values
`default_stock_mode`	`keep_in_sync`, `do_not_sync`, `always_in_stock`, `never_in_stock`

MinimalOrder

Order and goodsout creation result.

Fields

Key	Description	Type	Expanding
`order_id`	Order ID.	`number`	No
`goodsout_ids`	Goodsout IDs.	`array<Number>`	No

OrderChannels

Customer order groups.

Fields

Key	Description	Type	Expanding
`id`	ID of the channel.	`number`	No
`organisation_id`	ID of the organisation the channel belongs to.	`number`	No
`name`	The name of the channel.	`string`	No
`short_code`	A short string identifier of the channel.	`string`	No
`status`	The status of the channel.	`enum` * see below	No
`created`	Created timestamp in BladePRO.	`date`	No
`modified`	Last modified timestamp in BladePRO.	`date`	No
`brands`	List of related brands	`array<Brands>`	Yes
`organisation`	List of related brands	`Organisations`	Yes
`tax`	Default tax rate	`OrganisationTaxes`	Yes
`default_warehouse`	Default warehouse	`Warehouses`	Yes

Enums

Field	Values
`status`	`active`, `inactive`

OrderGoodsoutAddresses

Data related to an address.

Fields

Key	Description	Type	Expanding
`id`	The address’ unique identifier.	`number`	No
`title`	Title.	`string`	No
`first_name`	First name.	`string`	No
`last_name`	Last name.	`string`	No
`company`	Company name.	`string`	No
`address_one`	First line of address.	`string`	No
`address_two`	Second line of address.	`string`	No
`address_three`	Third line of address.	`string`	No
`town`	Town.	`string`	No
`county`	County name.	`string`	No
`postcode`	Postcode.	`string`	No
`country_id`	ID of the country.	`number`	No
`email`	Email.	`string`	No
`mobile`	Mobile number.	`string`	No
`telephone`	Landline number.	`string`	No
`secondary_telephone`	Secondary telephone number.	`string`	No
`vat_number`	VAT number.	`string`	No
`modified`	Last modified timestamp in BladePRO.	`date`	No
`country`	The address country.	`Countries`	Yes

OrderGoodsoutAudits

Add a message to the order timeline.

Fields

Key	Description	Type	Expanding
`message`	The timeline entry.	`string`	No

OrderGoodsoutDespatchAttributes

Despatch attribute for an order item

Fields

Key	Description	Type	Expanding
`sku`	Product SKU.	`string`	No
`product_name`	Product name.	`string`	No
`attribute_name`	Attribute name.	`string`	No
`attribute_value`	Attribute value.	`string`	No

OrderGoodsoutDocumentUploadConfirmation

Confirmation of a file upload.

Fields

Key	Description	Type	Expanding
`success`	Whether the upload was successful or not.	`boolean`	No

OrderGoodsoutLineItemDespatchedStocks

Stock despatched for an specific line item.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`quantity`	Quantity despatched.	`number`	No
`expiry_date`	The expiry date despatched	`date`	No
`batch`	The batch code despatched.	`ProductComponentBatches`	Yes

OrderGoodsoutLineItems

An item inside a goodsout line.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`quantity`	Quantity ordered.	`number`	No
`expiry_date`	The expiry date specified	`date`	No
`principal_tax`	Tax rate applied to the line item.	`OrganisationTaxes`	Yes
`component`	The product component.	`ProductComponents`	Yes
`batch`	The batch code specified.	`ProductComponentBatches`	Yes
`despatched_stocks`	Despatched Stock.	`array<OrderGoodsoutLineItemDespatchedStocks>`	Yes

OrderGoodsoutLines

An order for a product.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`transaction_sku`	SKU used during the transaction.	`string`	No
`quantity`	Quantity ordered.	`number`	No
`discount_type`	Discount type.	`number`	No
`discount`	Discount amount.	`number`	No
`net_unit_principal`	Net unit price.	`number`	No
`principal_tax`	Tax rate applied to the line.	`OrganisationTaxes`	Yes
`status`	Line status.	`enum` * see below	No
`variation`	Product variation.	`ProductVariations`	Yes
`items`	Line items.	`array<OrderGoodsoutLineItems>`	Yes

Enums

Field	Values
`status`	`active`, `void`

OrderGoodsoutPackingListBox

A box with products packed into it.

Fields

Key	Description	Type	Expanding
`pallet`	If the box was placed on a pallet, the pallet’s data.	`OrderGoodsoutPackingListPallet`	Yes
`carton_reference`	The sequence number of the current box.	`number`	No
`carton_product_variation_id`	The product variation ID of the current box.	`number`	No
`sku`	The SKU of the current box.	`string`	No
`sscc_18`	The SSCC-18 barcode of the carton, if exists.	`string`	No
`weight`	Weight of the box in kilograms.	`string`	No
`height`	Height of the box in millimetres.	`string`	No
`width`	Width of the box in millimetres.	`string`	No
`depth`	Depth of the box in millimetres.	`string`	No
`contains`	List of products packed into the box.	`array<OrderGoodsoutPackingListProduct>`	Yes

OrderGoodsoutPackingListPallet

A pallet on a packing list.

Fields

Key	Description	Type	Expanding
`pallet_product_variation_id`	The product variation ID of the pallet.	`number`	No
`pallet_reference`	The sequence number of the pallet.	`number`	No
`sku`	The SKU of the pallet.	`string`	No
`weight_kg`	Weight of the pallet in kilograms.	`string`	No

OrderGoodsoutPackingListProduct

A pallet on a packing list.

Fields

Key	Description	Type	Expanding
`product_component_id`	The product component ID of the physical product.	`number`	No
`sku`	The SKU of the product component.	`string`	No
`name`	Name.	`string`	No
`quantity`	Quantity of the product in the box.	`number`	No
`colour`	Colour.	`number`	No
`size`	Size.	`number`	No
`style`	Style.	`number`	No
`type`	Type.	`number`	No
`quality`	Quality.	`number`	No

OrderGoodsoutShipmentTracking

A shipment tracking update of an order goodsout.

Fields

Key	Description	Type	Expanding
`message`	A summary text that describes the tracking event.	`string`	No
`location`	A text summary of where (location) the update has occurred.	`string`	No
`tracking_number`	The specific tracking number for the update.	`string`	No
`timestamp`	The date/time of when the update was created (UTC format only).	`date`	No

OrderGoodsoutTags

A tag linked to a order goodsout.

Fields

Key	Description	Type	Expanding
`id`	Tag ID.	`number`	No
`name`	The tag name.	`string`	No
`shortcode`	The tag code.	`string`	No
`description`	The tag description.	`string`	No
`created`	The date the tag was added created.	`date`	No

OrderGoodsouts

Customer order shipments.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`status`	Status.	`enum` * see below	No
`date_placed`	Placed date.	`date`	No
`despatch_date`	Despatch date.	`date`	No
`cancellation_date`	The date a goodsout was cancelled.	`date`	No
`despatch_on_date`	Despatch on date.	`date`	No
`type`	Goodsout type, as set when the goodsout was created.	`enum` * see below	No
`retailer_id`	ID of the retailer the goodsout is destined for. Null when the goodsout has no retailer.	`number`	No
`source`	Source.	`string`	No
`delivery_instructions`	Delivery instructions.	`string`	No
`gift_message`	Gift message.	`string`	No
`attributes`	List of attributes.	`array<CachedAttribute>`	Yes
`shipments`	List of shipments.	`array<Shipments>`	Yes
`lines`	List of lines.	`array<OrderGoodsoutLines>`	Yes
`tags`	Applied tags.	`array<Tags>`	Yes
`warehouse`	Warehouse.	`SummarisedWarehouse`	Yes
`order`	Order.	`Orders`	Yes
`shipping_address`	Shipping Address.	`OrderGoodsoutAddresses`	Yes

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`
`type`	`consumer`, `trade`, `retail`

OrderLineResourceMetadatas

Stores arbitrary data against a order line.

Fields

Key	Description	Type	Expanding
`key`	Key the piece of stored metadata is identified with.	`string`	No
`value`	Stored data metadata.	`string`	No

OrderResourceMetadatas

Stores arbitrary data against a order.

Fields

Key	Description	Type	Expanding
`key`	Key the piece of stored metadata is identified with.	`string`	No
`value`	Stored data metadata.	`string`	No

OrderReturnItemReasons

Order Return Item Reasons.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`name`	The reason for returning an item	`string`	No
`short_name`	Name to represent the return reason.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

OrderReturnItems

Order Return Items.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`order_return_id`	Order Return Id the item is attached to.	`number`	No
`order_goodsout_line_item_id`	The original goodsout line item the return is for.	`number`	No
`order_goodsout_line_id`	The original goodsout line the return is for.	`number`	No
`product_component_id`	The product component id.	`number`	No
`sku`	SKU of the product component.	`string`	No
`exchanged_product_component_id`	The product component that is being sent in exchange.	`number`	No
`expected_quantity`	The quantity expected	`number`	No
`received_quantity`	The quantity received	`number`	No
`expiry_date`	The expiry date of the product	`date`	No
`received_date`	The date the item was received into the warehouse	`date`	No
`action`	The action for this item	`enum` * see below	No
`order_return_item_reason_id`	The return reason id	`number`	No
`description`	Description of the returned item	`string`	No
`correct_item`	Was the item sent correct?	`enum` * see below	No
`resellable`	Is the item in a resellable state?	`enum` * see below	No
`status`	The status of the return item	`enum` * see below	No
`authorisation_required`	Does the return item require authorisation?	`enum` * see below	No
`rejected_reason`	Reason for rejecting the return of this item	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`reason`	The reason for returning the item.	`OrderReturnItemReasons`	Yes
`component`	The product component being returned.	`ProductComponents`	Yes
`exchange_component`	The product component being sent in exchange.	`ProductComponents`	Yes

Enums

Field	Values
`action`	`refund`, `exchange`, `stock`
`correct_item`	`YES`, `NO`, `NOT_RECEIVED`
`resellable`	`YES`, `NO`
`status`	`pending`, `received`, `complete`, `void`, `draft`, `rejected`, `pending_refund`, `not_received`
`authorisation_required`	`YES`, `NO`

OrderReturnTags

A tag linked to a return.

Fields

Key	Description	Type	Expanding
`id`	Tag ID.	`number`	No
`name`	The tag name.	`string`	No
`shortcode`	The tag code.	`string`	No
`description`	The tag description.	`string`	No
`created`	The date the tag was added created.	`date`	No

OrderReturns

Order Returns.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`order_id`	Order Id the return is attached to.	`number`	No
`shipping_address_id`	Shipping Address Record.	`number`	No
`warehouse_id`	The warehouse dealing with the return.	`number`	No
`status`	Status of the return	`enum` * see below	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`warehouse`	The warehouse dealing with the return.	`Warehouses`	Yes
`order`	The order related to the return.	`Orders`	Yes
`order_return_items`	The items being returned.	`array<OrderReturnItems>`	Yes
`tags`	Tags attached to the return.	`array<SummarisedTag>`	Yes

Enums

Field	Values
`status`	`draft`, `pending`, `received`, `rejected`, `awaiting_despatch`, `complete`, `delivered`, `customer_service`

Orders

Customer order groups.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`reference`	Unique reference.	`string`	No
`status`	Order status.	`enum` * see below	No
`goodsouts`	List of goodsouts.	`array<OrderGoodsouts>`	Yes
`channel`	Order Channel.	`OrderChannels`	Yes

Enums

Field	Values
`status`	`draft`, `open`, `complete`, `cancelled`

OrganisationTaxes

Organisation tax data.

Fields

Key	Description	Type	Expanding
`id`	ID of the tax.	`number`	No
`name`	Name of the tax.	`string`	No
`code`	Code of the tax.	`string`	No
`rate`	Rate of the tax.	`number`	No
`description`	The description of the tax.	`string`	No
`active`	Is this tax currently active?	`boolean`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

Organisations

Organisation data.

Fields

Key	Description	Type	Expanding
`id`	ID of the organisation.	`number`	No
`name`	Name of the organisation.	`string`	No
`active`	Is the organisation currently active?	`boolean`	No
`vat_number`	VAT number.	`string`	No
`notes`	Notes.	`string`	No
`contact_name`	Name of contact staff.	`string`	No
`contact_phone`	Telephone number of contact staff.	`string`	No
`contact_mobile`	Mobile number contact staff.	`string`	No
`contact_email`	Email address of contact staff.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

Ports

Shipping ports.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`name`	Name.	`string`	No
`cbm`	CBM.	`number`	No

ProductAudits

Add a message to the product timeline.

Fields

Key	Description	Type	Expanding
`message`	The timeline entry.	`string`	No

ProductBrands

Product brand data.

Fields

Key	Description	Type	Expanding
`id`	ID of the product brand.	`number`	No
`name`	Name of the product brand.	`string`	No
`organisation_id`	ID of the parent organisation.	`number`	No
`active`	Is the product brand currently active?	`boolean`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`organisation`	The parent organisation.	`Organisations`	Yes

ProductChannelCategories

Product channel category data.

Fields

Key	Description	Type	Expanding
`id`	ID of the product channel category.	`number`	No
`name`	Name of the product channel category.	`string`	No
`parent_id`	ID of the parent product channel category.	`number`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`parent`	The parent product channel category.	`ProductChannelCategories`	Yes

ProductChannelVariations

Marketplace listable products’ search data.

Fields

Key	Description	Type	Expanding
`channel`	The product channel id.	`number`	No
`sku`	The unique stock keeping unit.	`string`	No
`product_component_sku`	The unique stock keeping unit.	`string`	No
`product_component_supplier_id`	The component supplier id.	`number`	No
`product_component_id`	The component id.	`number`	No
`warehouse_id`	The warehouse id.	`number`	No

ProductChannels

Geographical region data.

Fields

Key	Description	Type	Expanding
`id`	ID of the product channel.	`number`	No
`organisation_id`	ID of the parent organisation.	`number`	No
`status`	The status of the product channel.	`enum` * see below	No
`outbound_email`	The email address used for outbound messages.	`string`	No
`default_warehouse_id`	ID of the default warehouse.	`number`	No
`default_product_brand_id`	ID of the default brand.	`number`	No
`global`	Is this channel global to all clients?	`boolean`	No
`name`	The name of the product channel.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`default_product_brand`	The default brand.	`ProductBrands`	Yes
`default_warehouse`	The default warehouse.	`Warehouses`	Yes
`organisation`	The parent organisation.	`Organisations`	Yes

Enums

Field	Values
`status`	`active`, `inactive`

ProductComponentBatches

Description of a batch.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`reference`	Reference.	`string`	No
`description`	Description.	`string`	No
`created`	Created date.	`date`	No
`modified`	Last modified date.	`date`	No

ProductComponentCostPriceTransports

Transport costs.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`description`	Description.	`string`	No
`net_price`	Net price.	`number`	No
`tax_id`	Tax ID.	`number`	No
`currency_code`	Currency code.	`string`	No
`created`	Created date.	`date`	No
`modified`	Last modified date.	`date`	No

ProductComponentCostPrices

A cost price.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`notes`	Notes.	`string`	No
`net_cost_price`	Net cost price.	`number`	No
`currency_code`	Currency code.	`string`	No
`cost_price_duty_rate`	Duty rate.	`number`	No
`created`	Created date.	`date`	No
`modified`	Last modified date.	`date`	No
`currency`	Currency.	`SummarisedCurrency`	Yes
`transports`	Transports.	`ProductComponentCostPriceTransports`	Yes
`transport_total`	Summary of goodsin item’s transport costs in the warehouse’s currency.	`number`	No
`transport_total_po_curr`	Summary of goodsin item’s transport costs in the purchase order’s currency.	`number`	No

ProductComponentCustomsCodes

Product component customs codes.

Fields

Key	Description	Type	Expanding
`id`	ID of the customs code.	`number`	No
`code`	The HS code.	`string`	No
`name`	Name of the code.	`string`	No
`duty_rate`	The duty rate applied to this customs code.	`number`	No
`organisation_id`	The organisation that this code applies to.	`number`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`organisation`	Organisation	`Organisations`	Yes

ProductComponentDoqTypes

Product component DOQ Types.

Fields

Key	Description	Type	Expanding
`id`	ID of the component DOQ.	`number`	No
`code`	Short code for the DOQ.	`enum` * see below	No
`name`	Name of the DOQ type.	`string`	No

Enums

Field	Values
`code`	`INNER_PACK`, `MASTER_CASE`, `PALLET`, `SINGLE_PRODUCT`

ProductComponentDoqs

Product component DOQ.

Fields

Key	Description	Type	Expanding
`id`	ID of the component DOQ.	`number`	No
`quantity`	Quantity represented by the DOQ.	`number`	No
`weight`	Total weight in KG.	`number`	No
`depth`	Total depth in MM.	`number`	No
`width`	Total width in MM.	`number`	No
`height`	Total height in MM.	`number`	No
`shippable`	Can this DOQ value be shipped without additional packaging.	`boolean`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`type`	DOQ type.	`ProductComponentDoqTypes`	Yes

ProductComponentInstances

Component instance.

Fields

Key	Description	Type	Expanding
`id`	The component instance id.	`number`	No
`product_component_id`	The component this instance is attached to.	`number`	No
`component`	The product component.	`ProductComponents`	Yes

ProductComponentLandedPrices

Landed prices.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`product_component_instance_id`	Product component instnace ID.	`number`	No
`product_component_id`	Product component ID.	`number`	No
`net_cost_price`	Net cost price.	`number`	No
`cost_price_currency_code`	Cost price currency code.	`string`	No
`cost_currency`	Cost price currency.	`Currencies`	Yes
`cost_price_duty_rate`	Cost price duty rate.	`number`	No
`notes`	Notes.	`string`	No
`landed_price_currency_code`	Landed price currency code.	`string`	No
`landed_currency`	Landed price currency.	`SummarisedCurrency`	Yes
`stock`	Stock.	`number`	No
`created`	Created date in BladePRO.	`date`	No
`landed_price`	Landed price.	`number`	No

ProductComponentSalesSummary

Sales summary for a product.

Fields

Key	Description	Type	Expanding
`1_week`	Sold in the last week.	`number`	No
`1_month`	Sold in the last month.	`number`	No
`3_months`	Sold in the last three months.	`number`	No
`6_months`	Sold in the last six months.	`number`	No
`1_year`	Sold in the last year.	`number`	No
`lifetime`	Sold in the product’s lifetime.	`number`	No

ProductComponentStockSummary

Stock summary for a product component.

Fields

Key	Description	Type	Expanding
`total`	Total stock.	`number`	No
`total_saleable`	Total saleable stock.	`number`	No
`saleable`	Saleable stock.	`number`	No
`pickable`	Pickable stock.	`number`	No
`available`	Available stock.	`number`	No
`allocated`	Allocated stock.	`number`	No
`reserved`	Reserved stock.	`number`	No
`misc`	Miscellaneous stock.	`number`	No
`gistock`	Goodsin stock.	`number`	No
`expected`	Stock expected to arrive.	`number`	No
`picked`	Picked stock.	`number`	No
`under_investigation`	Stock under investigation.	`number`	No

ProductComponentSuppliers

Product Suppliers.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`organisation_id`	Parent organisation ID.	`number`	No
`name`	Name.	`string`	No
`active`	Is the supplier active?	`boolean`	No
`port_id`	ID of shipping port.	`number`	No
`currency_code`	Code of currency.	`string`	No
`nominal_code`	Nominal code.	`string`	No
`xero_code`	Accounting code.	`string`	No
`organisation_tax_id`	Tax ID.	`number`	No
`currency`	Currency.	`SummarisedCurrency`	Yes

ProductComponents

Product component.

Fields

Key	Description	Type	Expanding
`id`	ID of the product variation.	`number`	No
`status`	The status of the product component.	`enum` * see below	No
`sku`	The unique stock keeping unit.	`string`	No
`barcode`	Picking Barcode.	`string`	No
`perishable`	Is the product perishable.	`boolean`	No
`fragile`	Is the product fragile.	`boolean`	No
`battery`	Does the product contain a battery.	`boolean`	No
`dangerous`	Is the product dangerous.	`boolean`	No
`organic`	Is the product organic.	`boolean`	No
`what_is_it`	Customs - What is the product.	`string`	No
`made_of`	Customs - What is the product made of.	`string`	No
`used_for`	Customs - What is the product used for.	`string`	No
`customs_country_of_origin_country_id`	Customs - Country of origin.	`number`	No
`product_component_customs_code_id`	Customs - HS Code.	`number`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`doqs`	Component DOQs.	`array<ProductComponentDoqs>`	Yes
`last_cost`	Last cost.	`ProductComponentLandedPrices`	Yes
`stock`	Stock summary.	`ProductComponentStockSummary`	Yes
`count_product_component_batches`	Count of batches.	`number`	No
`sales`	Sales summary.	`ProductComponentSalesSummary`	Yes
`batch_codes_enabled`	Batch codes enabled.	`string`	No

Enums

Field	Values
`status`	`active`, `draft`, `discontinued`

ProductResourceMetadatas

Stores arbitrary data against a product.

Fields

Key	Description	Type	Expanding
`key`	Key the piece of stored metadata is identified with.	`string`	No
`value`	Stored data metadata.	`string`	No

ProductVariationBatchStockDataSummary

Variation batch stock breakdown.

Fields

Key	Description	Type	Expanding
`product_variation_id`	Product variation ID.	`number`	No
`batch_code`	Natch code.	`string`	No
`warehouse_id`	Warehouse ID.	`number`	No
`warehouse_code`	Warehouse code.	`string`	No
`warehouse_name`	Warehouse name.	`string`	No
`total`	Total number of units available.	`number`	No
`total_saleable`	Total number of units saleable.	`number`	No
`saleable`	Saleable units.	`number`	No
`available`	Available units.	`number`	No
`allocated`	Allocated units.	`number`	No
`misc`	Misc units.	`number`	No
`expected`	Expected units.	`number`	No
`under_investigation`	Stock under investigation.	`number`	No

ProductVariationComponents

Variation component.

Fields

Key	Description	Type	Expanding
`product_variation_id`	The variation that the component is attached to.	`number`	No
`product_component_instance_id`	The component instance.	`number`	No
`quantity`	Total quantity of this component inside the variation.	`number`	No
`instance`	The product component instance.	`ProductComponentInstances`	Yes

ProductVariationDescriptions

Variation descriptions.

Fields

Key	Description	Type	Expanding
`id`	The product variation description id.	`number`	No
`product_variation_id`	The product variation id.	`number`	No
`locale_id`	The description locale.	`number`	No
`name`	The product name.	`string`	No
`full_description`	The description of the product.	`string`	No
`created`	The created date.	`date`	No
`modified`	The last modified date.	`date`	No
`locale`	The locale for this description.	`Locales`	Yes

ProductVariationPerishableStockDataSummary

Variation perishable stock breakdown.

Fields

Key	Description	Type	Expanding
`product_variation_id`	Product variation ID.	`number`	No
`expiry_date`	Expiry date.	`date`	No
`warehouse_id`	Warehouse ID.	`number`	No
`warehouse_code`	Warehouse code.	`string`	No
`warehouse_name`	Warehouse name.	`string`	No
`total`	Total number of units available.	`number`	No
`total_saleable`	Total number of units saleable.	`number`	No
`saleable`	Saleable units.	`number`	No
`available`	Available units.	`number`	No
`allocated`	Allocated units.	`number`	No
`misc`	Misc units.	`number`	No
`expected`	Expected units.	`number`	No
`under_investigation`	Stock under investigation.	`number`	No

ProductVariationStockDataOnHand

Variation stock data on hand

Fields

Key	Description	Type	Expanding
`on_hand_total`	Total Products on Hand	`number`	No
`available`	Total Products Available	`number`	No
`committed`	Total Products Committed	`ProductVariationStockDataOnHandCommitted`	Yes
`unsaleable`	Total Unsellable Products on Hand	`ProductVariationStockDataOnHandUnsellable`	Yes
`under_investigation`	Stock under investigation	`number`	No

ProductVariationStockDataOnHandCommitted

Variation stock data committed

Fields

Key	Description	Type	Expanding
`committed_total`	Total Products Commited	`number`	No
`allocated`	Total Products Allocated	`number`	No
`picked`	Total Products Picked	`number`	No

ProductVariationStockDataOnHandUnsellable

Variation stock data unsellable

Fields

Key	Description	Type	Expanding
`unsaleable_total`	Total Unsellable Products on Hand	`number`	No
`batch_reserved`	Batch Reserved Stock	`number`	No
`ring_fenced`	Ring Fenced Stock	`number`	No
`goodsin_processing`	Goods In Processing Stock	`number`	No
`returns_processing`	Returns Processing Stock	`number`	No
`stock_processing`	Stock Processing	`number`	No
`quarantine`	Quarantine Stock	`number`	No
`expired`	Expired Stock	`number`	No

ProductVariationStockDataSummary

Variation stock breakdown.

Fields

Key	Description	Type	Expanding
`product_variation_id`	Product variation ID.	`number`	No
`warehouse_id`	Warehouse ID.	`number`	No
`warehouse_code`	Warehouse code.	`string`	No
`warehouse_name`	Warehouse name.	`string`	No
`total`	Total number of units available.	`number`	No
`total_saleable`	Total number of units saleable.	`number`	No
`saleable`	Saleable units.	`number`	No
`available`	Available units.	`number`	No
`allocated`	Allocated units.	`number`	No
`misc`	Misc units.	`number`	No
`expected`	Expected units.	`number`	No
`under_investigation`	Stock under investigation.	`number`	No

ProductVariationStockDataSummaryV2

Variation stock breakdown. This endpoint always expands all expandables.

Fields

Key	Description	Type	Expanding
`product_variation_id`	Product variation ID.	`number`	No
`warehouse_id`	Warehouse ID.	`number`	No
`warehouse_code`	Warehouse code.	`string`	No
`warehouse_name`	Warehouse name.	`string`	No
`on_hand`	Stock On Hand.	`ProductVariationStockDataOnHand`	Yes
`expected`	Stock Expected	`number`	No

ProductVariationTags

A tag linked to a product variation.

Fields

Key	Description	Type	Expanding
`id`	Tag ID.	`number`	No
`name`	The tag name.	`string`	No
`shortcode`	The tag code.	`string`	No
`description`	The tag description.	`string`	No
`created`	The date the tag was added created.	`date`	No

ProductVariationTypes

Product variation type data.

Fields

Key	Description	Type	Expanding
`id`	ID of the variation type.	`number`	No
`name`	Name of the product variation type.	`string`	No
`type`	Category of the product variation type.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

ProductVariations

Marketplace listable products’ data.

Fields

Key	Description	Type	Expanding
`id`	ID of the product variation.	`number`	No
`product_id`	ID of the parent product.	`number`	No
`status`	The status of the product variation.	`enum` * see below	No
`sku`	The unique stock keeping unit.	`string`	No
`barcode`	The product variation barcode.	`string`	No
`product_variation_type_id`	ID of the product variation type.	`number`	No
`discontinued_date`	The date the product was discontinued on.	`date`	No
`despatch_instructions`	Instructions for the staff.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`product`	Product.	`Products`	Yes
`type`	The product variation type.	`ProductVariationTypes`	Yes
`components`	The variation components.	`array<ProductVariationComponents>`	Yes
`descriptions`	The variation descriptions.	`array<ProductVariationDescriptions>`	Yes
`primary_component`	The primary component.	`array<ProductComponents>`	Yes
`tags`	The variation tags.	`array<Tags>`	Yes
`stock_data_summaries`	Stock.	`array<ProductVariationStockDataSummary>`	Yes

Enums

Field	Values
`status`	`active`, `draft`, `discontinued`

Products

Product data. Products are grouping entries and may represent multiple different kinds of physical products.

Fields

Key	Description	Type	Expanding
`id`	ID of the product.	`number`	No
`product_channel_id`	ID of the product channel.	`number`	No
`product_brand_id`	ID of the parent brand.	`number`	No
`product_category_id`	ID of the parent product category.	`number`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`channel`	The parent product channel.	`ProductChannels`	Yes
`brand`	The parent brand.	`ProductBrands`	Yes
`product_category`	The parent product category.	`ProductChannelCategories`	Yes
`variations`	The product variations.	`array<ProductVariations>`	Yes

PurchaseOrderAudits

Add a message to the purchase order timeline.

Fields

Key	Description	Type	Expanding
`message`	The timeline entry.	`string`	No

PurchaseOrderGoodsinContainers

A container for a goodsin.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`size`	Size.	`enum` * see below	No
`expected_quantity`	Expected quantity.	`number`	No
`received_quantity`	Expected quantity.	`number`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date.	`date`	No

Enums

Field	Values
`size`	`20FT`, `40FT`, `40FT-HC`

PurchaseOrderGoodsinItemIssues

Identified issue during receiving.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`name`	Name.	`string`	No
`description`	Description.	`string`	No
`photo_required`	Is a photo required when this issue is encountered?	`boolean`	No

PurchaseOrderGoodsinItems

Received items for a goodsin.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`product_component_id`	Product component ID.	`number`	No
`quantity`	Received quantity.	`number`	No
`expiry_date`	Expiry date.	`date`	No
`product_component_batch_id`	Batch ID.	`number`	No
`purchase_order_goodsin_item_issue_id`	Issue ID.	`number`	No
`product_component_cost_price_id`	Cost price ID.	`number`	No
`created`	Created date.	`date`	No
`modified`	Last modified date.	`date`	No
`component`	Product component.	`ProductComponents`	Yes
`batch`	Product component batch.	`ProductComponentBatches`	Yes
`issue`	Identified issue during receiving.	`PurchaseOrderGoodsinItemIssues`	Yes
`cost`	Cost price used.	`ProductComponentCostPrices`	Yes
`count_audit_ids`	Count of timeline items against the goodsin item.	`number`	No

PurchaseOrderGoodsins

One shipment to a purchase order.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`source`	Source.	`string`	No
`shipping_company`	Shipping company.	`string`	No
`tracking_number`	Tracking number.	`string`	No
`expected_pallets`	Number of expected pallets.	`number`	No
`expected_cartons`	Number of expected cartons.	`number`	No
`received_pallets`	Number of received pallets.	`number`	No
`received_cartons`	Number of received cartons.	`number`	No
`received_container`	Type of received container.	`enum` * see below	No
`container_shipment`	Is this a container shipment?	`boolean`	No
`container_size`	Size of the container.	`enum` * see below	No
`expected_delivery_date`	Expected delivery date.	`date`	No
`expected_delivery_time_slot`	Expected delivery time slot.	`enum` * see below	No
`preferred_delivery_date`	Preferred delivery date.	`date`	No
`preferred_delivery_time_slot`	Preferred delivery time slot.	`enum` * see below	No
`shipping_method`	Shipping method.	`enum` * see below	No
`port_id`	ID of the port.	`number`	No
`purchase_order_goodsin_shipping_term_id`	Shipping term ID.	`number`	No
`status`	Goodsin status.	`enum` * see below	No
`is_third_party`	Is this a third party goodsin?	`boolean`	No
`third_party_emails`	Third party email addresses.	`string`	No
`third_party_contact_name`	Third party contact names.	`string`	No
`booking_requested`	Booking requested date.	`date`	No
`booking_approved_by`	User ID.	`number`	No
`booking_approved`	Booking approved date.	`date`	No
`unique_booking_reference`	Booking reference.	`string`	No
`check_in_by`	Check in by date.	`date`	No
`transport_costs_locked`	Date the transport costs have been locked on.	`date`	No
`lock_user_id`	ID of the locking user.	`number`	No
`receiving_started`	Date of the start of receving.	`date`	No
`receiving_completed`	Date of the end of receving.	`date`	No
`checkin_started`	Date of the start of checkin.	`date`	No
`checkin_completed`	Date of the end of checkin.	`date`	No
`putaway_started`	Date of the start of putaway.	`date`	No
`putaway_completed`	Date of the end of putaway.	`date`	No
`ignore_from_billing`	Should the goodsin be ignored from billing?	`boolean`	No
`returns_damaged_count`	The amount returned because of damage.	`number`	No
`returns_unidentifiable_count`	The amount returned because the items had been unidentifiable.	`number`	No
`created`	Created date.	`date`	No
`modified`	Last modified date.	`date`	No
`containers`	Received containers.	`array<PurchaseOrderGoodsinContainers>`	Yes
`port`	Shipping port.	`Ports`	Yes
`consignment_qualities`	Quality descriptions.	`array<ConsignmentQualities>`	Yes
`items`	Received items.	`array<PurchaseOrderGoodsinItems>`	Yes

Enums

Field	Values
`received_container`	`20FT`, `40FT`, `40FT-HC`
`container_size`	`none`, `half`, `full`
`expected_delivery_time_slot`	`am`, `pm`
`preferred_delivery_time_slot`	`am`, `pm`
`shipping_method`	`air`, `sea`, `road`, ````
`status`	`awaiting_booking`, `awaiting_shipping`, `awaiting_receiving`, `awaiting_checkin`, `awaiting_putaway`, `completed`, `cancelled`, `awaiting_collection`

PurchaseOrderLines

An item ordered in a purchase order.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`product_component_id`	Product component ID.	`number`	No
`name`	Product component name.	`string`	No
`quantity`	Requested quantity.	`number`	No
`cost_price`	Cost price.	`number`	No
`duty`	Duty.	`number`	No
`capture_batch_code_on_checkin`	The way to handle batch code capturing.	`enum` * see below	No
`batch_code`	Batch code ID if batch code capturing is predefined.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date.	`date`	No
`component`	Product component.	`ProductComponents`	Yes
`count_audit_ids`	Count of timeline entries against the line.	`number`	No
`doq`	Denominations of quantity.	`ProductComponentDoqs`	Yes

Enums

Field	Values
`capture_batch_code_on_checkin`	`predefined`, `capture`

PurchaseOrderPayments

Payments made towards purchase order suppliers.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`name`	Name.	`string`	No
`amount`	Amount paid.	`number`	No
`currency_code`	Currency code.	`string`	No
`effective_date`	Effective date.	`date`	No
`currency`	Currency.	`SummarisedCurrency`	Yes

PurchaseOrderReferences

Purchase order references.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`value`	Value.	`string`	No

PurchaseOrderResourceMetadatas

Stores arbitrary data against a purchase order.

Fields

Key	Description	Type	Expanding
`key`	Key the piece of stored metadata is identified with.	`string`	No
`value`	Stored data metadata.	`string`	No

PurchaseOrderTags

A tag linked to a purchase order.

Fields

Key	Description	Type	Expanding
`id`	Tag ID.	`number`	No
`name`	The tag name.	`string`	No
`shortcode`	The tag code.	`string`	No
`description`	The tag description.	`string`	No
`created`	The date the tag was added created.	`date`	No

PurchaseOrderTypes

Types of purchase orders

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`code`	Code.	`string`	No
`name`	Name.	`string`	No
`description`	Description.	`string`	No

PurchaseOrders

Purchase orders.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`product_channel_id`	ID of the product channel.	`number`	No
`purchase_order_type_id`	ID of the purchase order type.	`number`	No
`product_component_supplier_id`	Supplier ID.	`number`	No
`warehouse_id`	Warehouse ID.	`number`	No
`currency_id`	Currency ID.	`number`	No
`status`	Purchase order status.	`enum` * see below	No
`notification_email_addresses`	Notification email address.	`string`	No
`comments`	Comments.	`string`	No
`reject_reason`	Reason for rejecting the purchase order.	`string`	No
`approved_date`	Date the purchase order was accepted on.	`date`	No
`completed_date`	Date of completion.	`date`	No
`discount`	Discount amount.	`number`	No
`discount_type`	Discount type.	`enum` * see below	No
`created`	Created date.	`date`	No
`modified`	Last modified date.	`date`	No
`warehouse`	Warehouse.	`SummarisedWarehouse`	Yes
`currency`	Currency.	`SummarisedCurrency`	Yes
`channel`	Product channel details.	`CachedProductChannel`	Yes
`type`	Purchase order type.	`PurchaseOrderTypes`	Yes
`supplier`	Supplier.	`ProductComponentSuppliers`	Yes
`lines`	Ordered lines.	`array<PurchaseOrderLines>`	Yes
`payments`	Payments made to suppliers.	`array<PurchaseOrderPayments>`	Yes
`goodsins`	List of goodsins.	`array<PurchaseOrderGoodsins>`	Yes
`tags`	List of applied tags.	`array<Tags>`	Yes
`references`	List of references.	`array<PurchaseOrderReferences>`	Yes

Enums

Field	Values
`status`	`draft`, `cancelled`, `awaiting_approval`, `awaiting_booking`, `rejected`, `open`, `completed`, `discrepancies`, `pending_completion`
`discount_type`	`percentage`, `value`

RegionSettings

Settings data for geographical regions.

Fields

Key	Description	Type	Expanding
`id`	ID of the region setting.	`number`	No
`region_id`	The ID of the region the setting relates to.	`number`	No
`region`	The region the setting relates to.	`Regions`	Yes
`setting`	Descriptive name of the setting.	`string`	No
`value`	Value of the setting.	`string`	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

Regions

Geographical region data.

Fields

Key	Description	Type	Expanding
`id`	ID of the region.	`number`	No
`name`	Descriptive name of the region.	`string`	No
`region_settings`	Settings of the region.	`array<RegionSettings>`	Yes

Retailers

A retailer that orders can be despatched on behalf of.

Fields

Key	Description	Type	Expanding
`id`	The retailer’s unique identifier.	`number`	No
`name`	Name of the retailer.	`string`	No
`description`	Description of the retailer.	`string`	No
`active`	Is the retailer switched on?	`number`	No
`created`	Created timestamp in BladePRO.	`date`	No
`modified`	Last modified timestamp in BladePRO.	`date`	No

ReturnResourceMetadatas

Stores arbitrary data against a return.

Fields

Key	Description	Type	Expanding
`key`	Key the piece of stored metadata is identified with.	`string`	No
`value`	Stored data metadata.	`string`	No

Shipments

Data related to a shipment.

Fields

Key	Description	Type	Expanding
`shipping_service`	Shipping service used.	`ShippingServices`	Yes

ShippingCourierAccounts

Shipping courier account data.

Fields

Key	Description	Type	Expanding
`name`	Account name.	`string`	No
`courier`	The courier.	`CachedNameAndCode`	Yes

ShippingServices

Customer order shipments.

Fields

Key	Description	Type	Expanding
`name`	Service name.	`string`	No
`code`	Service code.	`string`	No
`courier_account`	Courier account.	`ShippingCourierAccounts`	Yes

StockAvailability

Variation specific data.

Fields

Key	Description	Type	Expanding
`id`	The product variation id.	`number`	No
`sku`	The product SKU.	`string`	No
`barcode`	The product variation barcode.	`string`	No
`stocks`	Stocks.	`array`	Yes

SummarisedCountry

A country.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`iso_2`	The 2-letter ISO abbreviation.	`string`	No
`iso_3`	The 3-letter ISO abbreviation.	`string`	No

SummarisedCurrency

A currency.

Fields

Key	Description	Type	Expanding
`code`	Code.	`string`	No
`name`	Name.	`string`	No
`symbol`	Symbol.	`string`	No

SummarisedLocale

Locale / Language.

Fields

Key	Description	Type	Expanding
`id`	Locale id.	`number`	No
`name`	Name of the locale.	`string`	No
`code`	Short code for the locale.	`string`	No
`created`	When the locale was created.	`date`	No
`modified`	When the locale was modified.	`date`	No

SummarisedProductCategory

Summary of a product category.

Fields

Key	Description	Type	Expanding
`id`	The ID of the product category.	`number`	No
`name`	The name of the product category.	`string`	No

SummarisedProductVariationType

Top level product data.

Fields

Key	Description	Type	Expanding
`id`	The product type id.	`number`	No
`name`	The product type name.	`string`	No
`type`	Category of the product variation type.	`string`	No

SummarisedTag

A tag.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`shortcode`	Short code.	`string`	No
`description`	Short description.	`string`	No

SummarisedWarehouse

A warehouse.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`short_code`	Code.	`string`	No
`name`	Name.	`string`	No
`country`	Country.	`SummarisedCountry`	Yes

SyncedMarketplaceListing

Sync marketplace listing

Fields

Key	Description	Type	Expanding
`listing_reference`	The parent or first marketplace reference for the listing as provided in the request.	`string`	No
`listing_variation_reference`	The child or second marketplace reference for the listing as provided in the request.	`string`	No
`sku`	The product SKU for the listing.	`string`	No
`result`	The outcome for this listing.	`enum` * see below	No
`error`	The marketplace reference for the listing as provided in the request.	`string`	No

Enums

Field	Values
`result`	`unchanged`, `created`, `updated`, `removed`, `errored`

Templates

Template.

Fields

Key	Description	Type	Expanding
`id`	ID of the template.	`number`	No
`organisation_id`	ID of the organisation.	`number`	No
`template_category_id`	ID of the template category.	`number`	No
`template_category_code`	Code of the template category.	`number`	No
`name`	Name of the template.	`string`	No
`status`	Orientation.	`enum` * see below	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No

Enums

Field	Values
`status`	`portrait`, `landscape`

VendorOrderItemStatuses

A status for a vendor order item.

Fields

Key	Description	Type	Expanding
`id`	The status’ unique identifier.	`number`	No
`name`	Name of the status.	`string`	No
`group`	Name of the status’ group.	`string`	No
`accepted`	Has the vendor order line been accepted?	`boolean`	No
`created`	Created timestamp in BladePRO.	`date`	No
`modified`	Last modified timestamp in BladePRO.	`date`	No

VendorOrderItems

A line in a vendor order.

Fields

Key	Description	Type	Expanding
`id`	The vendor order item’s unique identifier.	`number`	No
`vendor_order_id`	The vendor order’s unique identifier.	`number`	No
`vendor_order_item_status_id`	The vendor order item status’ unique identifier.	`number`	No
`model_number`	The product’s model number.	`string`	No
`asin`	The product’s ASIN.	`string`	No
`sku`	The product’s SKU.	`string`	No
`product_variation_id`	The product variation’s unique identifier.	`number`	No
`name`	The product’s name.	`string`	No
`expected_delivery_date`	Expected delivery date.	`date`	No
`confirmed_delivery_date`	Confirmed delivery date.	`date`	No
`submitted_quantity`	Submitted quantity, as requested by the vendor.	`number`	No
`accepted_quantity`	Accepted quantity, as confirmed.	`number`	No
`received_quantity`	Received quantity.	`number`	No
`unit_cost`	Unit cost.	`number`	No
`created`	Created timestamp in BladePRO.	`date`	No
`modified`	Last modified timestamp in BladePRO.	`date`	No
`vendor_order`	The vendor order.	`VendorOrders`	Yes
`status`	The vendor order item status.	`VendorOrderItemStatuses`	Yes
`product_variation`	The product variation.	`ProductVariations`	Yes

VendorOrderResourceMetadatas

Stores arbitrary data against a vendor order.

Fields

Key	Description	Type	Expanding
`key`	Key the piece of stored metadata is identified with.	`string`	No
`value`	Stored data metadata.	`string`	No

VendorOrders

A vendor order.

Fields

Key	Description	Type	Expanding
`id`	The vendor order’s unique identifier.	`number`	No
`code`	Identifier created by vendor.	`string`	No
`status`	Status in BladePRO.	`enum` * see below	No
`vendor`	Vendor identifier.	`string`	No
`ordered_on`	Vendor order created date at vendor’s side.	`date`	No
`deliver_from`	Delivery window’s start date.	`date`	No
`deliver_to`	Delivery window’s end date.	`date`	No
`freight_terms`	Vendor’s freight terms.	`string`	No
`payment_method`	Vendor’s payment method.	`string`	No
`payment_terms`	Vendor’s payment terms.	`string`	No
`purchasing_entity`	Vendor description.	`string`	No
`delivery_party`	Delivery Party.	`string`	No
`order_channel_id`	Order channel’s unique identifier.	`number`	No
`currency_id`	ID of the currency.	`number`	No
`warehouse_id`	ID of the fulfilling warehouse.	`number`	No
`finalised`	Finalised date.	`date`	No
`address_first_name`	First name part of the address.	`string`	No
`address_last_name`	Last name part of the address.	`string`	No
`address_company`	Company part of the address.	`string`	No
`address_line_one`	Line one of the address.	`string`	No
`address_line_two`	Line two of the address.	`string`	No
`address_line_three`	Line three of the address.	`string`	No
`address_postcode`	Postcode part of the address.	`string`	No
`address_town`	Town part of the address.	`string`	No
`address_county`	County part of the address.	`string`	No
`address_country_id`	ID of the country of the address.	`string`	No
`created`	Created timestamp in BladePRO.	`date`	No
`modified`	Last modified timestamp in BladePRO.	`date`	No
`order_channel`	The order channel.	`OrderChannels`	Yes
`currency`	The currency.	`Currencies`	Yes
`warehouse`	The fulfilling warehouse.	`Warehouses`	Yes
`address_country`	The address country.	`Countries`	Yes
`items`	List of items in the vendor order.	`array<VendorOrderItems>`	Yes

Enums

Field	Values
`status`	`unconfirmed`, `processing`, `confirmed`, `void`

VirtualStocks

A stock entry.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`virtual_warehouse_location_id`	Location ID.	`number`	No
`product_variation_id`	Product variation ID.	`number`	No
`quantity`	Quantity in stock.	`number`	No
`expiry_date`	Expiry date.	`date`	No
`created`	Created timestamp in BladePRO.	`date`	No
`modified`	Last modified date.	`date`	No
`location`	The virtual warehouse location.	`VirtualWarehouseLocations`	Yes
`product_variation`	Product variation.	`ProductVariations`	Yes

VirtualWarehouseLocations

A location in a virtual warehouse.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`barcode`	Identifier of the location.	`string`	No
`virtual_warehouse_id`	The ID of the virtual warehouse the location belongs to.	`number`	No
`active`	Is the location active?	`boolean`	No
`sellable`	Should the stock in this location be considered sellable?	`boolean`	No
`created`	Created timestamp in BladePRO.	`date`	No
`warehouse`	The virtual warehouse.	`VirtualWarehouses`	Yes

VirtualWarehouses

Storages that are outside of BladePRO’s control, such as showrooms, or stock at Amazon’s warehouse.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`name`	Name.	`string`	No
`description`	Description.	`string`	No
`active`	Is the warehouse currently active?	`boolean`	No
`api_managed_only`	Is the warehouse managed by an API?	`boolean`	No
`location_creation_enabled`	Is it possible to create locations?	`boolean`	No
`created`	Created timestamp in BladePRO.	`date`	No
`locations`	List of locations.	`array<VirtualWarehouseLocations>`	Yes

Warehouses

A warehouse.

Fields

Key	Description	Type	Expanding
`id`	The warehouse’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`short_code`	Unique short code.	`string`	No
`latitude`	Latitude coordinate.	`number`	No
`longitude`	Longitude coordinate.	`number`	No
`country_id`	ID of the warehouse’s country.	`number`	No
`active`	Is the warehouse switched on?	`boolean`	No
`currency_id`	ID of the warehouse’s currency.	`number`	No
`virtual`	Is the warehouse virtual?	`boolean`	No
`return_warehouse_id`	ID of the return warehouse, if the returns for this warehouse are redirected.	`number`	No
`created`	Created timestamp in BladePRO.	`date`	No
`modified`	Last modified timestamp in BladePRO.	`date`	No
`currency`	The warehouse’s currency.	`Currencies`	Yes
`country`	The warehouse’s country.	`Countries`	Yes
`return_warehouse`	The return warehouse, if the returns for this warehouse are redirected.	`Warehouses`	Yes

Tasks

Fields

Key	Description	Type	Expanding
`task_reference`	Reference for accessing the task.	`string`	No

WebhookOrderCancelled

Order cancelled webhook.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`status`	Status.	`enum` * see below	No
`date_placed`	Placed date.	`date`	No
`source`	Source.	`string`	No
`order`	Order parent.	`WebhookOrderCancelledOrder`	Yes
`warehouse`	Warehouse.	`WebhookOrderCancelledWarehouse`	Yes
`shipping_address`	Shipping address.	`WebhookOrderCancelledAddress`	Yes
`attributes`	Attributes.	`array<WebhookOrderCancelledAttribute>`	Yes
`tags`	Tags.	`array<WebhookOrderCancelledTag>`	Yes

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`

WebhookOrderCancelledAddress

Address data.

Fields

Key	Description	Type	Expanding
`first_name`	First name.	`string`	No
`last_name`	Last name.	`string`	No
`company`	Company name.	`string`	No
`email`	Email.	`string`	No
`country`	The address country.	`WebhookOrderCancelledCountry`	Yes

WebhookOrderCancelledAttribute

An attribute stored against an order.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`value`	Value.	`string`	No

WebhookOrderCancelledCountry

Country data.

Fields

Key	Description	Type	Expanding
`id`	The country’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`iso_2`	ISO2 description.	`string`	No
`iso_3`	ISO3 description.	`string`	No

WebhookOrderCancelledOrder

Parent order.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`reference`	Unique reference.	`string`	No
`status`	Order status.	`enum` * see below	No
`order_channel_id`	Order channel ID.	`number`	No
`brand_id`	Brand ID.	`number`	No
`currency`	Currency.	`WebhookOrderCancelledOrderCurrency`	Yes
`channel`	Channel.	`WebhookOrderCancelledOrderChannel`	Yes

Enums

Field	Values
`status`	`draft`, `open`, `complete`, `cancelled`

WebhookOrderCancelledOrderChannel

Channel data.

Fields

Key	Description	Type	Expanding
`id`	BladePRO id for channel.	`number`	No
`organisation_id`	Organisation id.	`number`	No
`name`	Name.	`string`	No
`outbound_email`	Outbound email.	`string`	No

WebhookOrderCancelledOrderCurrency

Currency data.

Fields

Key	Description	Type	Expanding
`id`	BladePRO id for currency.	`number`	No
`name`	Name.	`string`	No
`code`	Code.	`string`	No
`symbol`	Symbol.	`string`	No

WebhookOrderCancelledTag

Tag on order.

Fields

Key	Description	Type	Expanding
`id`	Tag ID.	`number`	No
`name`	The tag name.	`string`	No
`shortcode`	The tag code.	`string`	No

WebhookOrderCancelledWarehouse

Warehouse data.

Fields

Key	Description	Type	Expanding
`id`	The warehouse’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`short_code`	Unique short code.	`string`	No
`country`	The warehouse’s country.	`WebhookOrderCancelledCountry`	Yes

WebhookOrderCollected

Order collected webhook. Sent when an order has been marked as collected via the collection system.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`status`	Status.	`enum` * see below	No
`substatus`	Substatus. Always `collected` for this webhook.	`string`	No
`date_placed`	Placed date.	`date`	No
`despatch_date`	Despatched date.	`date`	No
`collection_date`	Collection date.	`date`	No
`source`	Source.	`string`	No
`order`	Order parent.	`WebhookOrderDespatchedOrder`	Yes
`warehouse`	Warehouse.	`WebhookOrderDespatchedWarehouse`	Yes
`shipping_address`	Shipping address.	`WebhookOrderDespatchedAddress`	Yes
`attributes`	Attributes.	`array<WebhookOrderDespatchedAttribute>`	Yes
`despatch_attributes`	Product Component Despatched Attributes.	`array<WebhookOrderProductComponentDespatchedAttribute>`	Yes
`tags`	Tags.	`array<WebhookOrderDespatchedTag>`	Yes
`shipping`	Shipping details.	`WebhookOrderDespatchedShipping`	Yes

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`

WebhookOrderConfirmed

Order confirmed webhook.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`status`	Status.	`enum` * see below	No
`date_placed`	Placed date.	`date`	No
`source`	Source.	`string`	No
`order`	Order parent.	`WebhookOrderConfirmedOrder`	Yes
`warehouse`	Warehouse.	`WebhookOrderConfirmedWarehouse`	Yes
`shipping_address`	Shipping address.	`WebhookOrderConfirmedAddress`	Yes
`attributes`	Attributes.	`array<WebhookOrderConfirmedAttribute>`	Yes
`tags`	Tags.	`array<WebhookOrderConfirmedTag>`	Yes

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`

WebhookOrderConfirmedAddress

Address data.

Fields

Key	Description	Type	Expanding
`first_name`	First name.	`string`	No
`last_name`	Last name.	`string`	No
`company`	Company name.	`string`	No
`email`	Email.	`string`	No
`country`	The address country.	`WebhookOrderConfirmedCountry`	Yes

WebhookOrderConfirmedAttribute

An attribute stored against an order.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`value`	Value.	`string`	No

WebhookOrderConfirmedCountry

Country data.

Fields

Key	Description	Type	Expanding
`id`	The country’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`iso_2`	ISO2 description.	`string`	No
`iso_3`	ISO3 description.	`string`	No

WebhookOrderConfirmedOrder

Parent order.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`reference`	Unique reference.	`string`	No
`status`	Order status.	`enum` * see below	No
`order_channel_id`	Order channel ID.	`number`	No
`brand_id`	Brand ID.	`number`	No
`currency`	Currency.	`WebhookOrderConfirmedOrderCurrency`	Yes

Enums

Field	Values
`status`	`draft`, `open`, `complete`, `cancelled`

WebhookOrderConfirmedOrderCurrency

Currency data.

Fields

Key	Description	Type	Expanding
`id`	BladePRO id for currency.	`number`	No
`name`	Name.	`string`	No
`code`	Code.	`string`	No
`symbol`	Symbol.	`string`	No

WebhookOrderConfirmedTag

Tag on order.

Fields

Key	Description	Type	Expanding
`id`	Tag ID.	`number`	No
`name`	The tag name.	`string`	No
`shortcode`	The tag code.	`string`	No

WebhookOrderConfirmedWarehouse

Warehouse data.

Fields

Key	Description	Type	Expanding
`id`	The warehouse’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`short_code`	Unique short code.	`string`	No
`country`	The warehouse’s country.	`WebhookOrderConfirmedCountry`	Yes

WebhookOrderCreated

Order created webhook.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`status`	Status.	`enum` * see below	No
`date_placed`	Placed date.	`date`	No
`source`	Source.	`string`	No
`order`	Order parent.	`WebhookOrderCreatedOrder`	Yes
`warehouse`	Warehouse.	`WebhookOrderCreatedWarehouse`	Yes
`shipping_address`	Shipping address.	`WebhookOrderCreatedAddress`	Yes
`lines`	Lines.	`array<WebhookOrderCreatedLine>`	Yes
`attributes`	Attributes.	`array<WebhookOrderCreatedAttribute>`	Yes
`tags`	Tags.	`array<WebhookOrderCreatedTag>`	Yes

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`

WebhookOrderCreatedAddress

Address data.

Fields

Key	Description	Type	Expanding
`first_name`	First name.	`string`	No
`last_name`	Last name.	`string`	No
`company`	Company name.	`string`	No
`email`	Email.	`string`	No
`country`	The address country.	`WebhookOrderCreatedCountry`	Yes

WebhookOrderCreatedAttribute

An attribute stored against an order.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`value`	Value.	`string`	No

WebhookOrderCreatedCountry

Country data.

Fields

Key	Description	Type	Expanding
`id`	The country’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`iso_2`	ISO2 description.	`string`	No
`iso_3`	ISO3 description.	`string`	No

WebhookOrderCreatedLine

Order line data.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`transaction_sku`	SKU used during the transaction.	`string`	No
`quantity`	Quantity ordered.	`number`	No
`net_unit_principal`	Net unit principle.	`number`	No
`net_unit_commission`	Net unit commission.	`number`	No
`status`	Line status.	`enum` * see below	No
`created`	Created date in BladePRO.	`date`	No
`modified`	Last modified date in BladePRO.	`date`	No
`variation`	Product variation.	`WebhookOrderCreatedProductVariation`	Yes

Enums

Field	Values
`status`	`active`, `void`

WebhookOrderCreatedOrder

Parent order.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`reference`	Unique reference.	`string`	No
`status`	Order status.	`enum` * see below	No
`channel`	Order channel.	`WebhookOrderCreatedOrderChannel`	Yes
`brand`	Brand.	`WebhookOrderCreatedOrderBrand`	Yes
`currency`	Currency.	`WebhookOrderCreatedOrderCurrency`	Yes

Enums

Field	Values
`status`	`draft`, `open`, `complete`, `cancelled`

WebhookOrderCreatedOrderBrand

Brand data.

Fields

Key	Description	Type	Expanding
`id`	ID of the brand.	`number`	No
`name`	Name of the brand.	`string`	No

WebhookOrderCreatedOrderChannel

Order channel data.

Fields

Key	Description	Type	Expanding
`id`	ID of the channel.	`number`	No
`name`	The name of the channel.	`string`	No
`short_code`	A short string identifier of the channel.	`string`	No

WebhookOrderCreatedOrderCurrency

Currency data.

Fields

Key	Description	Type	Expanding
`id`	BladePRO id for currency.	`number`	No
`name`	Name.	`string`	No
`code`	Code.	`string`	No
`symbol`	Symbol.	`string`	No

WebhookOrderCreatedProductVariation

Product variation data.

Fields

Key	Description	Type	Expanding
`id`	ID of the product variation.	`number`	No
`product_id`	ID of the parent product.	`number`	No
`sku`	The unique stock keeping unit.	`string`	No

WebhookOrderCreatedTag

Tag on order.

Fields

Key	Description	Type	Expanding
`id`	Tag ID.	`number`	No
`name`	The tag name.	`string`	No
`shortcode`	The tag code.	`string`	No

WebhookOrderCreatedWarehouse

Warehouse data.

Fields

Key	Description	Type	Expanding
`id`	The warehouse’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`short_code`	Unique short code.	`string`	No
`country`	The warehouse’s country.	`WebhookOrderCreatedCountry`	Yes

WebhookOrderDespatched

Order despatched webhook.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`status`	Status.	`enum` * see below	No
`date_placed`	Placed date.	`date`	No
`despatch_date`	Despatched date.	`date`	No
`source`	Source.	`string`	No
`order`	Order parent.	`WebhookOrderDespatchedOrder`	Yes
`warehouse`	Warehouse.	`WebhookOrderDespatchedWarehouse`	Yes
`shipping_address`	Shipping address.	`WebhookOrderDespatchedAddress`	Yes
`attributes`	Attributes.	`array<WebhookOrderDespatchedAttribute>`	Yes
`despatch_attributes`	Product Component Despatched Attributes.	`array<WebhookOrderProductComponentDespatchedAttribute>`	Yes
`tags`	Tags.	`array<WebhookOrderDespatchedTag>`	Yes
`shipping`	Shipping details.	`WebhookOrderDespatchedShipping`	Yes

Enums

Field	Values
`status`	`draft`, `awaiting_allocation`, `hung`, `returned`, `awaiting_payment`, `awaiting_picking`, `awaiting_despatch`, `backorder_release`, `backorder`, `cancelled`, `return_open`, `item_refunded`, `item_replaced`, `awaiting_collection`, `despatched`

WebhookOrderDespatchedAddress

Address data.

Fields

Key	Description	Type	Expanding
`first_name`	First name.	`string`	No
`last_name`	Last name.	`string`	No
`company`	Company name.	`string`	No
`email`	Email.	`string`	No
`country`	The address country.	`WebhookOrderDespatchedCountry`	Yes

WebhookOrderDespatchedAttribute

An attribute stored against an order.

Fields

Key	Description	Type	Expanding
`name`	Name.	`string`	No
`value`	Value.	`string`	No

WebhookOrderDespatchedCountry

Country data.

Fields

Key	Description	Type	Expanding
`id`	The country’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`iso_2`	ISO2 description.	`string`	No
`iso_3`	ISO3 description.	`string`	No

WebhookOrderDespatchedOrder

Parent order.

Fields

Key	Description	Type	Expanding
`id`	ID.	`number`	No
`reference`	Unique reference.	`string`	No
`status`	Order status.	`enum` * see below	No
`order_channel_id`	Order channel ID.	`number`	No
`brand_id`	Brand ID.	`number`	No
`currency`	Currency.	`WebhookOrderDespatchedOrderCurrency`	Yes
`channel`	Channel.	`WebhookOrderDespatchedOrderChannel`	Yes

Enums

Field	Values
`status`	`draft`, `open`, `complete`, `cancelled`

WebhookOrderDespatchedOrderChannel

Channel data.

Fields

Key	Description	Type	Expanding
`id`	BladePRO id for channel.	`number`	No
`organisation_id`	Organisation id.	`number`	No
`name`	Name.	`string`	No
`outbound_email`	Outbound email.	`string`	No

WebhookOrderDespatchedOrderCurrency

Currency data.

Fields

Key	Description	Type	Expanding
`id`	BladePRO id for currency.	`number`	No
`name`	Name.	`string`	No
`code`	Code.	`string`	No
`symbol`	Symbol.	`string`	No

WebhookOrderDespatchedShipping

Shipping details.

Fields

Key	Description	Type	Expanding
`courier_name`	Name of the shipping courier.	`string`	No
`service_name`	Name of the shipping service.	`string`	No
`tracking`	Tracking numbers.	`array<WebhookOrderDespatchedShippingTracking>`	Yes

WebhookOrderDespatchedShippingTracking

Tracking details.

Fields

Key	Description	Type	Expanding
`tracking_number`	Tracking number.	`string`	No
`tracking_url`	Tracking url.	`string`	No

WebhookOrderDespatchedTag

Tag on order.

Fields

Key	Description	Type	Expanding
`id`	Tag ID.	`number`	No
`name`	The tag name.	`string`	No
`shortcode`	The tag code.	`string`	No

WebhookOrderDespatchedWarehouse

Warehouse data.

Fields

Key	Description	Type	Expanding
`id`	The warehouse’s unique identifier.	`number`	No
`name`	Name.	`string`	No
`short_code`	Unique short code.	`string`	No
`country`	The warehouse’s country.	`WebhookOrderDespatchedCountry`	Yes

WebhookOrderProductComponentDespatchedAttribute

Attribute of Despatched Product Component.

Fields

Key	Description	Type	Expanding
`sku`	Product SKU.	`string`	No
`attribute_name`	Attribute name.	`string`	No
`attribute_value`	Attribute value.	`string`	No
`order_goodsout_line_id`	The line reference that the attribute was applied to.	`number`	No
`order_goodsout_line_item_id`	The line item reference that the attribute was applied to.	`number`	No

WebhookReturnCompleted

Order return completed webhook.

Fields

Key	Description	Type	Expanding
`return_id`	Return ID.	`number`	No
`order_id`	Order ID	`number`	No
`order_reference`	Order reference	`string`	No
`order_channel_id`	Order channel ID	`number`	No
`return_created`	Return created timestamp.	`date`	No
`carrier`	Carrier name	`string`	No
`service`	Service type	`string`	No
`tracking_number`	Tracking number	`string`	No
`warehouse_id`	Warehouse ID	`number`	No
`received_date`	Return received.	`date`	No
`completed_date`	Return completed.	`date`	No
`return_items`	Return items list	`array<WebhookReturnCompletedItem>`	Yes

WebhookReturnCompletedItem

Fields

Key	Description	Type	Expanding
`sku`	Product SKU	`string`	No
`product_component_id`	Product component ID	`number`	No
`return_quantity`	Quantity being returned	`number`	No
`return_reason`	Reason for return	`string`	No
`exchange_or_refund`	Exchange or refund type	`string`	No
`exchange_product_component_id`	Exchange product component ID (if exchange)	`number`	No
`expected_quantity`	Expected quantity to be returned	`number`	No
`received_quantity`	Actual quantity received	`number`	No
`correct_item`	Whether the returned item is correct	`string`	No
`resellable`	Whether the item is resellable	`string`	No

WebhookReturnCreated

Order return created webhook.

Fields

Key	Description	Type	Expanding
`return_id`	Return ID.	`number`	No
`order_id`	Order ID	`number`	No
`order_reference`	Order reference	`string`	No
`order_channel_id`	Order channel ID	`number`	No
`return_created`	Return created timestamp.	`date`	No
`carrier`	Carrier name	`string`	No
`service`	Service type	`string`	No
`tracking_number`	Tracking number	`string`	No
`warehouse_id`	Warehouse ID	`number`	No
`return_items`	Return items list	`array<WebhookReturnCreatedItem>`	Yes

WebhookReturnCreatedItem

Fields

Key	Description	Type	Expanding
`sku`	Product SKU	`string`	No
`product_component_id`	Product component ID	`number`	No
`return_quantity`	Quantity being returned	`number`	No
`return_reason`	Reason for return	`string`	No
`exchange_or_refund`	Exchange or refund type	`string`	No

WebhookReturnReceived

Return received webhook.

Fields

Key	Description	Type	Expanding
`return_id`	Return ID.	`number`	No
`order_id`	Order ID.	`number`	No
`order_reference`	Unique reference.	`string`	No
`order_channel_id`	Order Channel ID.	`number`	No
`return_created`	Return created.	`date`	No
`carrier`	Carrier.	`string`	No
`service`	Service.	`string`	No
`tracking_number`	Tracking number.	`string`	No
`warehouse_id`	Warehouse ID.	`number`	No
`received_date`	Return received.	`date`	No

WebhookVendorOrderFinalised

Vendor order finalise webhook.

Fields

Key	Description	Type	Expanding
`id`	Unique BladePRO identifier for the vendor order.	`number`	No
`code`	Reference for the vendor order.	`string`	No
`vendor`	Vendor.	`string`	No
`status`	Status of the vendor order.	`string`	No
`delivery_party`	Delivery Party.	`string`	No
`address_first_name`	Delivery Address: First name.	`string`	No
`address_last_name`	Delivery Address: Last name.	`string`	No
`address_company`	Delivery Address: Company.	`string`	No
`address_line_one`	Delivery Address: Line one.	`string`	No
`address_line_two`	Delivery Address: Line two.	`string`	No
`address_line_three`	Delivery Address: Line three.	`string`	No
`address_postcode`	Delivery Address: Postcode.	`string`	No
`address_town`	Delivery Address: Town.	`string`	No
`address_county`	Delivery Address: county.	`string`	No
`finalised`	Datetime for when the vendor order was finalised.	`date`	No
`order_channel`	The vendor order channel.	`WebhookVendorOrderFinalisedOrderChannel`	Yes
`country`	Delivery country.	`WebhookVendorOrderFinalisedCountry`	Yes
`selected_warehouse`	The warehouse from where the stock will be despatched from.	`WebhookVendorOrderFinalisedWarehouse`	Yes
`currency`	Currency of the vendor order.	`WebhookVendorOrderFinalisedCurrency`	Yes
`items`	Vendor items.	`array<WebhookVendorOrderFinalisedItem>`	Yes

WebhookVendorOrderFinalisedCountry

Delivery location.

Fields

Key	Description	Type	Expanding
`id`	BladePRO identifier for the country.	`number`	No
`name`	Name of the country.	`string`	No
`iso_2`	ISO 2 Code.	`string`	No
`iso_3`	ISO 3 code.	`string`	No

WebhookVendorOrderFinalisedCurrency

vendor order currency.

Fields

Key	Description	Type	Expanding
`id`	BladePRO id for currency.	`number`	No
`name`	Name.	`string`	No
`code`	Code.	`string`	No
`symbol`	Symbol.	`string`	No

WebhookVendorOrderFinalisedItem

item.

Fields

Key	Description	Type	Expanding
`id`	BladePRO identifier for the vendor order item.	`number`	No
`product_variation_id`	BladePRO identifier for product.	`number`	No
`sku`	sku.	`string`	No
`submitted_quantity`	Vendor Submitted Quantity.	`number`	No
`accepted_quantity`	Quantity accepted in BladePRO.	`number`	No
`unit_cost`	Net Unit Cost	`number`	No
`status`	Status	`string`	No
`expected_delivery_date`	Expected Delivery Date	`date`	No

WebhookVendorOrderFinalisedOrderChannel

vendor order finalise webhook.

Fields

Key	Description	Type	Expanding
`id`	Channel id for the vendor order.	`number`	No
`name`	Channel name for the vendor order.	`string`	No

WebhookVendorOrderFinalisedWarehouse

Warehouse from which the vendor order will be despatched from.

Fields

Key	Description	Type	Expanding
`id`	BladePRO identifier for the warehouse.	`number`	No
`name`	Name of the warehouse.	`string`	No
`country`	Warehouse location.	`WebhookVendorOrderFinalisedWarehouseCountry`	Yes

WebhookVendorOrderFinalisedWarehouseCountry

Warehouse location.

Fields

Key	Description	Type	Expanding
`id`	BladePRO identifier for the country.	`number`	No
`name`	Name of the country.	`string`	No
`iso_2`	ISO 2 Code.	`string`	No
`iso_3`	ISO 3 code.	`string`	No