Integrations

Order integration

This controller handles order-related integration endpoints.

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

Method	Path	Operation
GET	`/api/v1/integration/orders/{integrationId}`	Get order
PUT	`/api/v1/integration/orders/{integrationId}`	Update order
POST	`/api/v1/integration/orders`	Create order

Get order

GET/api/v1/integration/orders/{integrationId}

Access. Send a bearer token or an API key. The caller needs the Orders view permission.

Parameters

Name	In	Type	Required	Description
`integrationId`	path	`string`	Yes
`configuredProviderId`	query	`string (uuid)`	No

Response

200. Returns a SingleResult envelope. The data field is IntegrationOrderApiResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/integration/orders/{integrationId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Update order

PUT/api/v1/integration/orders/{integrationId}

Access. Send a bearer token or an API key. The caller needs the Orders modify permission.

Parameters

Name	In	Type	Required	Description
`integrationId`	path	`string`	Yes

Request body

Send JSON with the shape IntegrationUpdateOrderCommand. Responsible for handling incoming order update requests from external integrations.

Field	Type	Required	Description
`order`	`UpdateOrderRequest`	No
`integrationContext`	`IntegrationContextRequest`	Yes

Response

200. Returns a SingleResult envelope. The data field is IntegrationOrderApiResponse.

Request

curl -X PUT "https://api.miridia.io/api/v1/integration/orders/{integrationId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "order": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "description": "string",
    "currencyCode": "Eur",
    "countryCode": "Global",
    "status": "New",
    "fulfillmentType": "Package",
    "fulfillmentSubType": "GeneralPackage",
    "dateOfScheduledCollection": "2026-09-29T08:00:00Z",
    "paymentProcessed": true,
    "paymentUrl": "string",
    "paymentMethod": "Cash"
  },
  "integrationContext": {
    "configuredProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "id": "string",
    "idType": "Long",
    "content": "string",
    "metadata": {
      "key": "string"
    },
    "reportedQuantity": 0,
    "dateCreated": "2026-09-29T08:00:00Z"
  }
}'

Create order

POST/api/v1/integration/orders

Access. Send a bearer token or an API key. The caller needs the Orders modify permission.

Request body

Send JSON with the shape CreateOrderIntegrationCommand. Incoming order creation request from an external integration. Composes a CreateOrderRequest with the integration-specific customer, order items, and context. External callers should leave those two properties empty.

Field	Type	Required
`order`	`CreateOrderRequest`	Yes
`customer`	`CreateCustomerIntegrationCommand`	Yes
`orderItems`	`IntegrationOrderItemRequest[]`	Yes
`context`	`IntegrationContextRequest`	Yes

Response

200. Returns a SingleResult envelope. The data field is OrderResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/integration/orders" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "order": {
    "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "salesChannelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "description": "string",
    "purchaseOrderNumber": "string",
    "currencyCode": "Eur",
    "countryCode": "Global",
    "weightType": "Kilogram",
    "paymentProcessed": true,
    "paymentMethod": "Cash",
    "fulfillmentType": "Package",
    "fulfillmentSubType": "GeneralPackage",
    "serviceLevel": "Standard",
    "dateOfScheduledCollection": "2026-09-29T08:00:00Z",
    "items": [
      {}
    ],
    "destinationAddress": {
      "placeId": "string",
      "name": "string",
      "website": "https://example.com",
      "fullAddress": "string",
      "street": "string",
      "suburb": "string",
      "city": "string",
      "country": "string",
      "postcode": "string",
      "unit": "string",
      "number": "string",
      "province": "string",
      "latitude": 0,
      "longitude": 0
    },
    "billing": {
      "subTotal": 0,
      "totalPrice": 0,
      "totalTax": 0,
      "totalDiscount": 0,
      "discount": 0,
      "discountType": "Percentage",
      "taxIncluded": true,
      "taxType": "Sales",
      "taxRate": 0
    },
    "metadata": {
      "key": "string"
    },
    "effectiveDate": "2026-09-29T08:00:00Z"
  },
  "customer": {
    "customer": {
      "contacts": [
        {}
      ],
      "phoneNumber": "string",
      "email": "name@example.com",
      "website": "https://example.com",
      "isBusiness": true,
      "businessName": "string",
      "title": "string",
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "shippingAddress": {},
      "billingAddress": {},
      "additionalAddresses": [
        {}
      ],
      "dateCreated": "2026-09-29T08:00:00Z",
      "metadata": {
        "key": "string"
      }
    },
    "context": {
      "configuredProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "id": "string",
      "idType": "Long",
      "content": "string",
      "metadata": {
        "key": "string"
      },
      "reportedQuantity": 0,
      "dateCreated": "2026-09-29T08:00:00Z"
    }
  },
  "orderItems": [
    {
      "title": "string",
      "description": "string",
      "quantity": 0,
      "taxIncluded": true,
      "subTotal": 0,
      "totalPrice": 0,
      "totalTax": 0,
      "totalDiscount": 0,
      "discount": 0,
      "weight": 0,
      "weightType": "Kilogram",
      "height": 0,
      "width": 0,
      "length": 0,
      "discountType": "Percentage",
      "productIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "context": {
    "configuredProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "id": "string",
    "idType": "Long",
    "content": "string",
    "metadata": {
      "key": "string"
    },
    "reportedQuantity": 0,
    "dateCreated": "2026-09-29T08:00:00Z"
  }
}'

Models

The operations on this page use these object types. Select a type to see its fields.

ActionMessage

Action messages surface to the API and provide more detailed user feedback for handled exceptions or errors.

Field	Type	Description
`title`	`string`
`message`	`string`
`level`	`enum NotificationLevel`	One of: `Standard`, `Info`, `Warning`, `Error`, `Success`, `Recommendation`.
`icon`	`enum MdiIcon`	One of: `None`, `SyncAlert`, `Autorenew`, `Check`, `CheckMarkedCircle`, `AlertCircle`, `TruckDeliveryOutline`, `TruckFastOutline`, `PackageCheck`, `Warehouse`, `SwapHorizontal`, `AccountCheck`, `AccountRemove`, `AccountCancel`, `Delete`.
`code`	`string`	The Notification code / Suggestion code for this suggestion

AddressResponse

Field	Type	Description
`id`	`string (uuid)`
`placeId`	`string`
`name`	`string`
`website`	`string`
`fullAddress`	`string`
`street`	`string`
`suburb`	`string`
`city`	`string`
`country`	`string`
`postcode`	`string`
`unit`	`string`
`number`	`string`
`province`	`string`
`latitude`	`number (double)`
`longitude`	`number (double)`

ContactResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`description`	`string`
`firstName`	`string`
`lastName`	`string`
`email`	`string`
`phoneNumber`	`string`
`mobileNumber`	`string`

CreateAddressRequest

Field	Type	Description
`placeId`	`string (string)`	Limits: maximum 100 characters.
`name`	`string (string)`	Limits: maximum 50 characters.
`website`	`string (uri)`	Limits: maximum 100 characters.
`fullAddress`	`string`	Limits: maximum 500 characters.
`street`	`string (string)`	Limits: maximum 80 characters.
`suburb`	`string (string)`	Limits: maximum 80 characters.
`city`	`string`	Limits: maximum 80 characters.
`country`	`string`	Limits: maximum 80 characters.
`postcode`	`string (postal-code)`	Limits: maximum 15 characters.
`unit`	`string`	Limits: maximum 10 characters.
`number`	`string (postal-code)`	Limits: maximum 20 characters.
`province`	`string (string)`	Limits: maximum 80 characters.
`latitude`	`number (double)`	Limits: minimum -90, maximum 90.
`longitude`	`number (double)`	Limits: minimum -180, maximum 180.

CreateContactCommand

Field	Type	Description
`id`	`string (uuid)`
`customerId`	`string (uuid)`
`title`	`string`	Limits: maximum 50 characters.
`description`	`string`	Limits: maximum 1000 characters.
`firstName`	`string`	Limits: maximum 50 characters.
`lastName`	`string`	Limits: maximum 50 characters.
`email`	`string (email)`
`phoneNumber`	`string (tel)`
`mobileNumber`	`string (tel)`

CreateCustomerIntegrationCommand

The incoming request to create a customer from an external integration. Composes a CreateCustomerRequest with the integration context so the underlying customer payload is defined exactly once.

Field	Type	Description
`customer`	`CreateCustomerRequest`
`context`	`IntegrationContextRequest`

CreateCustomerRequest

Field	Type	Description
`contacts`	`CreateContactCommand[]`
`phoneNumber`	`string (tel)`	Limits: maximum 20 characters.
`email`	`string (email)`	Limits: maximum 50 characters.
`website`	`string (uri)`	Limits: maximum 100 characters.
`isBusiness`	`boolean`
`businessName`	`string`	Limits: maximum 100 characters.
`title`	`string`	Limits: maximum 100 characters.
`groupId`	`string (uuid)`	The customer group this customer belongs to, if any. Used as a price-list assignment scope.
`shippingAddress`	`CreateAddressRequest`
`billingAddress`	`CreateAddressRequest`
`additionalAddresses`	`CreateAddressRequest[]`
`dateCreated`	`string (date-time)`	When the customer was created. Optional; defaults to now. Lets seeded/synthetic data show customer acquisition over time rather than all on seed day.
`metadata`	`map<string, string>`

CreateOrderItemRequest

Its billing fields are deliberately nullable (see below), which that non-nullable-decimal interface can't express.

Field	Type	Description
`productId`	`string (uuid)`
`quantity`	`number (double)`	Used when a product is assigned to a order
`dimensionPresetId`	`string (uuid)`
`title`	`string`
`description`	`string`
`primaryImageUrl`	`string`
`weight`	`number (double)`
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`subTotal`	`number (double)`	Null (or zero, matching the old non-nullable default) means "resolve this from price lists / price history". A non-zero value is a LINE TOTAL and is used unchanged. See `IOrderLinePricingService`.
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.

CreateOrderRequest

Field	Type	Description
`customerId`	`string (uuid)`
`locationId`	`string (uuid)`	The location/store this order originates at (its address becomes the order origin).
`salesChannelId`	`string (uuid)`	The sales channel (medium) this order comes through. Optional: when omitted, a manual order falls back to the business's default ("Direct") channel, and an integration-ingested order resolves the channel backed by its configured provider.
`description`	`string`
`purchaseOrderNumber`	`string`	The customer's purchase order number, when this order is created from a received customer PO.
`currencyCode`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`paymentProcessed`	`boolean`
`paymentMethod`	`enum PaymentMethod`	One of: `Unknown`, `Cash`, `Card`, `CashOnDelivery`, `CardOnDelivery`, `Eft`, `Crypto`, `Paypal`, `WireTransfer`, `DebitOrder`.
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`fulfillmentSubType`	`enum FulfillmentSubType`	One of: `Unknown`, `GeneralPackage`, `FoodDelivery`, `MedicalDelivery`, `GroceriesDelivery`, `StandardPallet`, `StandardInternationalPallet`, `StandardUsPallet`, `StandardEuroPallet`, `CustomPallet`, `General10Ft`, `General20Ft`, `HighCube20Ft`, `General40Ft`, `HighCube40Ft`, `General45Ft`, `HighCube45Ft`, `FlatRack20FtWithSides`, `FlatRack20FtWithoutSides`, `FlatRack40FtWithSides`, `FlatRack40FtWithoutSides`, `OpenTop20Ft`, `OpenTop40Ft`, `Reefer20Ft`, `Reefer40Ft`, `MiniVan`, `DryVan`, `Flatbed`, `Tanker`, `AutoHauler`, `BoxTruck`, `Trailer`, `LowBoy`, `Dumper`, `Pickup`, `TowTruck`, `DumpTruck`.
`serviceLevel`	`enum ServiceLevel`	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`dateOfScheduledCollection`	`string (date-time)`
`items`	`CreateOrderItemRequest[]`
`destinationAddress`	`CreateAddressRequest`
`billing`	`OrderBillingRequest`
`metadata`	`map<string, string>`
`effectiveDate`	`string (date-time)`	When the order actually occurred. Optional; defaults to now.

CurrencyResponse

Field	Type	Description
`iso4217`	`string`
`utf8Symbol`	`string`
`currencyCode`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.

CustomerIntegrationProviderResponse

Field	Type	Description
`provider`	`PrimitiveIntegrationProviderResponse`
`customer`	`CustomerResponse`

CustomerResponse

Field	Type	Description
`id`	`string (uuid)`
`isBusiness`	`boolean`
`title`	`string`
`website`	`string`
`email`	`string`
`businessName`	`string`
`groupId`	`string (uuid)`	The customer group this customer belongs to, if any. Used as a price-list assignment scope.
`phoneNumber`	`string`	This would generally represent the phone number for the customer if the customer is a business. Otherwise, the contact details should be part of the contact, and not the customer. Limits: maximum 20 characters.
`integrationType`	`enum IntegrationProviderType`	One of: `None`, `Commerce`, `Accounting`, `Erp`, `Crm`, `Fulfillment`, `Warehouse`, `WorkflowManager`.
`dateCreated`	`string (date-time)`
`billingAddress`	`AddressResponse`
`shippingAddress`	`AddressResponse`
`integrations`	`CustomerIntegrationProviderResponse[]`
`contacts`	`ContactResponse[]`
`primaryContact`	`ContactResponse`
`parent`	`CustomerResponse`
`attachments`	`MetadataFileAttachment[]`
`totalSales`	`integer (int32)`
`totalSpent`	`number (double)`
`metadata`	`map<string, string>`

DimensionPresetResponse

Field	Type	Description
`id`	`string (uuid)`
`vendor`	`string`	Limits: maximum 100 characters.
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`title`	`string`	Limits: maximum 200 characters.
`weight`	`number (double)`	The weight property acts as a limit for this specific box size.
`length`	`number (double)`
`width`	`number (double)`
`height`	`number (double)`
`defaultOption`	`boolean`	every business can have one package size preset set as the default option
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`dimensionType`	`GeometryFieldSymbol`

DimensionTypeWithSymbols

Field	Type	Description
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`volumeType`	`enum VolumeType`	One of: `None`, `Litre`, `CubicCentimeter`, `CubicMeter`, `Gallon`, `CubicInch`, `CubicFoot`.
`lengthSymbol`	`string`
`weightSymbol`	`string`
`volumeSymbol`	`string`

Geometry

Physical shipping geometry: the bounding measurements of an item plus the units they are expressed in. The single canonical shape for dimensions across the domain. Products, variants, shipments, order/shipment line items, and dimension presets all hold one of these instead of duplicating the Weight/Width/Length/Height quartet.

Field	Type	Description
`weight`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.

GeometryFieldsResponse

Field	Type	Description
`weight`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`weightSymbol`	`string`
`lengthSymbol`	`string`

IntegrationContextRequest

Field	Type	Description
`configuredProviderId`	`string (uuid)`
`id`	`string`
`idType`	`enum UidType`	One of: `Unknown`, `Long`, `Guid`, `String`.
`content`	`string`	Can be used to store the raw data received from the external system. Maps to SerializedData...
`metadata`	`map<string, string>`	Additional metadata related to the integration object.
`reportedQuantity`	`integer (int32)`	The available-to-sell quantity the provider reports for this product. Null when the provider does not report a quantity.
`dateCreated`	`string (date-time)`

IntegrationContextResponse

Field	Type	Description
`configuredProviderId`	`string (uuid)`
`id`	`string`
`idType`	`enum UidType`	One of: `Unknown`, `Long`, `Guid`, `String`.
`content`	`string`
`metadata`	`map<string, string>`

IntegrationCustomerResponse

The outgoing customer response from Miridia to an external integration.

Field	Type	Description
`integrationId`	`Uid`
`integrationIdType`	`enum UidType`	One of: `Unknown`, `Long`, `Guid`, `String`.
`customer`	`CustomerResponse`
`metadata`	`map<string, string>`
`integrationContext`	`IntegrationContextResponse`

IntegrationOrderApiResponse

The response sent from Miridia to the integration when creating or updating an order on the integration.

Field	Type	Description
`id`	`string`
`customerId`	`string`
`integrationId`	`Uid`
`integrationIdType`	`enum UidType`	One of: `Unknown`, `Long`, `Guid`, `String`.
`integrationCustomerId`	`Uid`
`order`	`OrderResponse`
`customer`	`IntegrationCustomerResponse`
`orderItems`	`IntegrationOrderItemResponse[]`
`integrationControls`	`OrderIntegrationControls`
`integrationContext`	`IntegrationContextResponse`
`metadata`	`map<string, string>`
`warnings`	`ActionMessage[]`

IntegrationOrderItemRequest

Field	Type	Description
`title`	`string`
`description`	`string`
`quantity`	`number (double)`
`taxIncluded`	`boolean`
`subTotal`	`number (double)`
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`weight`	`number (double)`
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`height`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.
`productIntegrationId`	`string (uuid)`	The integration must create the product first, then reference it here. When `null` the line item persists with no linked product.

IntegrationOrderItemResponse

Field	Type	Description
`integrationId`	`Uid`
`integrationIdType`	`enum UidType`	One of: `Unknown`, `Long`, `Guid`, `String`.
`productIntegrationId`	`Uid`
`productIntegrationVariantId`	`Uid`
`orderItem`	`OrderItemResponse`
`product`	`IntegrationProductResponse`
`integrationContext`	`IntegrationContextResponse`

IntegrationProductResponse

Field	Type	Description
`integrationId`	`Uid`
`integrationIdType`	`enum UidType`	One of: `Unknown`, `Long`, `Guid`, `String`.
`integrationOriginDateCreated`	`string (date-time)`	The date the product was originally created.
`product`	`ProductResponse`
`integrationContext`	`IntegrationContextResponse`
`metadata`	`map<string, string>`

MetadataFileAttachment

Not quite as complete as the normal FileAttachment aggregate.

Field	Type	Description
`id`	`string (uuid)`
`type`	`enum MetadataAttachmentType`	One of: `File`, `Link`.
`fileAttachmentId`	`string (uuid)`	Left as `Guid.Empty` for `Link` entries.
`title`	`string`
`url`	`string`
`contentType`	`string`
`description`	`string`

OrderBillingRequest

Field	Type	Description
`subTotal`	`number (double)`
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.
`taxIncluded`	`boolean`
`taxType`	`enum TaxType`	One of: `None`, `Sales`, `Vat`, `Gst`, `Pst`, `Hst`, `Qst`, `Ist`, `Ust`, `Cst`.
`taxRate`	`number (double)`

OrderCarrierMetadata

Field	Type	Description
`carrierId`	`string (uuid)`
`earliestCollection`	`string (date-time)`
`collectionRequested`	`string (date-time)`
`collectionAfterRequest`	`string (date-time)`
`dateDelivered`	`string (date-time)`
`dateOfReturnRequested`	`string (date-time)`
`timeframe`	`string`
`requestedCollection`	`boolean`
`shipmentLabelGenerated`	`boolean`
`requestedReturn`	`boolean`
`packageCount`	`integer (int32)`
`packages`	`OrderPackageMetadata[]`

OrderIntegrationControls

Field	Type	Description
`hasResolvedWeightType`	`boolean`
`hasResolvedLengthType`	`boolean`
`hasResolvedCurrency`	`boolean`
`hasResolvedCountry`	`boolean`
`hasResolvedProduct`	`boolean`
`hasResolvedCustomer`	`boolean`

OrderIntegrationDetailsResponse

Field	Type	Description
`id`	`string (uuid)`
`integrationId`	`string`	The integration id as displayed on the relevant integration
`provider`	`PrimitiveIntegrationProviderResponse`

OrderItemResponse

Order Item maps onto ProductOrder and contains a property with all of the product information.

Field	Type	Description
`id`	`string (uuid)`
`code`	`string`
`quantityOrdered`	`number (double)`
`unit`	`enum UnitOfMeasure`	One of: `Each`, `Kilogram`, `Gram`, `Litre`, `Millilitre`, `Metre`, `Centimetre`, `SquareMetre`, `CubicMetre`, `Pair`, `Pack`, `Box`, `Roll`, `Sheet`.
`orderShipment`	`OrderShipmentResponse`
`product`	`ProductResponse`
`shipment`	`ShipmentResponse`
`carrier`	`PrimitiveIntegrationProviderResponse`
`dimensionPreset`	`PrimitiveDimensionPreset`
`title`	`string`
`description`	`string`
`primaryImageUrl`	`string`
`geometry`	`GeometryFieldsResponse`
`billing`	`PriceDetailsResponse`

OrderPackageMetadata

Field	Type	Description
`productId`	`string (uuid)`
`dimensions`	`Geometry`

OrderResponse

Field	Type	Description
`dateCreated`	`string (date-time)`
`dateModified`	`string (date-time)`
`id`	`string (uuid)`
`code`	`string`
`deliveryItemCount`	`integer (int32)`
`orderItemCount`	`number (double)`	Total quantity of items ordered across all line items. Surfaced for list views.
`description`	`string`
`purchaseOrderNumber`	`string`	The customer's purchase order number, when this order was raised from a received customer PO.
`billing`	`PriceDetailsResponse`
`shippingCosts`	`OrderShippingCostsResponse`
`fulfillmentStatus`	`enum FulfillmentStatus`	One of: `Unknown`, `Unassigned`, `PendingCollection`, `PendingDelivery`, `Fulfilled`, `Cancelled`.
`customerIpAddress`	`string`
`serviceLevel`	`enum ServiceLevel`	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`status`	`enum OrderStatus`	One of: `Unknown`, `New`, `PendingCollection`, `PendingDelivery`, `Complete`, `Cancelled`, `PendingReturn`, `Returned`.
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`fulfillmentSubType`	`enum FulfillmentSubType`	One of: `Unknown`, `GeneralPackage`, `FoodDelivery`, `MedicalDelivery`, `GroceriesDelivery`, `StandardPallet`, `StandardInternationalPallet`, `StandardUsPallet`, `StandardEuroPallet`, `CustomPallet`, `General10Ft`, `General20Ft`, `HighCube20Ft`, `General40Ft`, `HighCube40Ft`, `General45Ft`, `HighCube45Ft`, `FlatRack20FtWithSides`, `FlatRack20FtWithoutSides`, `FlatRack40FtWithSides`, `FlatRack40FtWithoutSides`, `OpenTop20Ft`, `OpenTop40Ft`, `Reefer20Ft`, `Reefer40Ft`, `MiniVan`, `DryVan`, `Flatbed`, `Tanker`, `AutoHauler`, `BoxTruck`, `Trailer`, `LowBoy`, `Dumper`, `Pickup`, `TowTruck`, `DumpTruck`.
`dateOfScheduledCollection`	`string (date-time)`
`dateCreatedOnIntegration`	`string (date-time)`
`effectiveDate`	`string (date-time)`
`dateOfDeliveryCompletion`	`string (date-time)`
`dateImported`	`string (date-time)`
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`paymentProcessed`	`boolean`
`paymentUrl`	`string`
`integrationOrderUrl`	`string`
`multiCarrier`	`boolean`
`currencyCode`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.
`paymentMethod`	`enum PaymentMethod`	One of: `Unknown`, `Cash`, `Card`, `CashOnDelivery`, `CardOnDelivery`, `Eft`, `Crypto`, `Paypal`, `WireTransfer`, `DebitOrder`.
`attachments`	`MetadataFileAttachment[]`
`orderItems`	`OrderItemResponse[]`
`orderShipments`	`OrderShipmentResponse[]`
`destinationAddress`	`AddressResponse`
`originAddress`	`AddressResponse`
`originLocationId`	`string (uuid)`	The location/store the order is attributed to (trace which store it came from).
`originLocationTitle`	`string`
`sourceChannelId`	`string (uuid)`	The sales channel (medium) the order came through.
`sourceChannelTitle`	`string`
`sourceChannel`	`SalesChannelResponse`
`customer`	`CustomerResponse`
`carrierMetadata`	`OrderCarrierMetadata`
`dimensionType`	`DimensionTypeWithSymbols`
`currencyMetadata`	`CurrencyResponse`
`fulfillmentProviders`	`PrimitiveIntegrationProviderResponse[]`
`packageSizes`	`PrimitiveDimensionPreset[]`
`integrations`	`OrderIntegrationDetailsResponse[]`
`metadata`	`map<string, string>`

OrderShipmentResponse

Field	Type	Description
`shipmentQuotation`	`ShipmentQuotationResponse`
`order`	`OrderResponse`
`shipment`	`ShipmentResponse`
`fulfillmentProvider`	`PrimitiveIntegrationProviderResponse`
`canModifyItems`	`boolean`	Whether the item set of this shipment can still be changed, through `PUT /orders/{orderId}/shipments/{shipmentId}/items`. False once the shipment leaves the Active status, or once a label, an invoice, a fulfillment request, an approved quotation, or a manual lock names the load it carries.

OrderShippingCostsResponse

Field	Type	Description
`shippingSubTotal`	`number (double)`
`shippingDiscount`	`number (double)`
`shippingTax`	`number (double)`
`shippingTotal`	`number (double)`

PriceDetailsResponse

Field	Type	Description
`subTotal`	`number (double)`
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.
`taxIncluded`	`boolean`
`taxRate`	`number (double)`
`taxType`	`enum TaxType`	One of: `None`, `Sales`, `Vat`, `Gst`, `Pst`, `Hst`, `Qst`, `Ist`, `Ust`, `Cst`.
`currency`	`CurrencyResponse`

PrimitiveDimensionPreset

Field	Type	Description
`title`	`string`
`weight`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`id`	`string (uuid)`
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.

PrimitiveIntegrationProviderResponse

Field	Type	Description
`configuredProviderId`	`string (uuid)`
`id`	`integer (int32)`
`title`	`string`
`description`	`string`
`logoUrl`	`string`

ProductCategoryPrimitive

Field	Type	Description
`category`	`string`

ProductGeometryFieldsResponse

Field	Type	Description
`weight`	`number (double)`
`width`	`number (double)`
`length`	`number (double)`
`height`	`number (double)`
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`weightSymbol`	`string`
`lengthSymbol`	`string`
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`title`	`string`
`geometrySymbol`	`GeometryFieldSymbol`

ProductGroupSummaryResponse

Catalog-card summary of a product group (variant family): the umbrella name and how many products it contains. See group.

Field	Type	Description
`id`	`string (uuid)`
`name`	`string`
`variantCount`	`integer (int32)`

ProductIntegrationProviderResponse

Field	Type	Description
`provider`	`PrimitiveIntegrationProviderResponse`
`id`	`string (uuid)`	Represents the product integration id.
`integrationId`	`string`	The composite integration id in it's original form represented as a string. Refer to ProductService::GetProductResponse()
`product`	`ProductResponse`

ProductPriceDetailsResponse

Field	Type	Description
`subTotal`	`number (double)`
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.
`taxIncluded`	`boolean`
`taxRate`	`number (double)`
`taxType`	`enum TaxType`	One of: `None`, `Sales`, `Vat`, `Gst`, `Pst`, `Hst`, `Qst`, `Ist`, `Ust`, `Cst`.
`currency`	`CurrencyResponse`
`id`	`string (uuid)`
`purchasable`	`boolean`
`priceType`	`enum PriceType`	One of: `Selling`, `Purchase`, `Cost`.
`source`	`enum PriceSource`	One of: `Manual`, `SupplierUpdate`, `Import`, `Sync`, `Migration`.
`notes`	`string`
`effectiveDate`	`string (date-time)`
`currencyMetadata`	`CurrencyResponse`
`priceUnit`	`enum UnitOfMeasure`	One of: `Each`, `Kilogram`, `Gram`, `Litre`, `Millilitre`, `Metre`, `Centimetre`, `SquareMetre`, `CubicMetre`, `Pair`, `Pack`, `Box`, `Roll`, `Sheet`.
`pricePackQuantity`	`number (double)`
`pricePerUnit`	`number (double)`
`basis`	`enum PriceResolutionBasis`	One of: `FixedItem`, `PeggedItem`, `ListRule`.
`adjustmentType`	`enum PriceAdjustmentType`	One of: `Percentage`, `Amount`.
`adjustmentValue`	`number (double)`

ProductResponse

Field	Type	Description
`id`	`string (uuid)`
`code`	`string`
`sku`	`string`
`barcode`	`string`
`upc`	`string`
`ean`	`string`
`mpn`	`string`
`title`	`string`
`description`	`string`
`body`	`string`
`productLink`	`string`
`productType`	`enum ProductType`	One of: `FinishedGood`, `RawMaterial`, `Component`, `Consumable`, `Service`.
`status`	`enum ProductStatus`	One of: `Active`, `Inactive`, `Discontinued`.
`unit`	`enum UnitOfMeasure`	One of: `Each`, `Kilogram`, `Gram`, `Litre`, `Millilitre`, `Metre`, `Centimetre`, `SquareMetre`, `CubicMetre`, `Pair`, `Pack`, `Box`, `Roll`, `Sheet`.
`purchasable`	`boolean`
`isSellable`	`boolean`
`isPurchasable`	`boolean`
`isTaxable`	`boolean`
`requiresShipping`	`boolean`
`totalAvailableQuantity`	`number (double)`	Available stock derived from the inventory ledger: the sum of (on-hand − reserved) across the product's inventory records at all locations.
`totalSold`	`number (double)`
`totalSoldValue`	`number (double)`
`onSale`	`boolean`
`currentPrice`	`ProductPriceDetailsResponse`
`traces`	`ActionMessage[]`	Get the historical view of changes for this object
`defaultImage`	`MetadataFileAttachment`
`images`	`MetadataFileAttachment[]`
`attachments`	`MetadataFileAttachment[]`
`geometry`	`ProductGeometryFieldsResponse`
`integrations`	`ProductIntegrationProviderResponse[]`
`locale`	`SymbolicLocaleMetadata`
`dimensionPreset`	`DimensionPresetResponse`
`dimensionPresets`	`DimensionPresetResponse[]`
`categories`	`ProductCategoryPrimitive[]`
`supplier`	`SupplierResponse`
`group`	`ProductGroupSummaryResponse`
`tags`	`string[]`
`hasRating`	`boolean`
`rating`	`number (double)`
`metadata`	`map<string, string>`
`dateCreated`	`string (date-time)`

SalesChannelResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`kind`	`enum SalesChannelKind`	One of: `Direct`, `PointOfSale`, `Online`, `Marketplace`.
`defaultLocationId`	`string (uuid)`

ShipmentQuotationResponse

Field	Type	Description
`id`	`string (uuid)`
`provider`	`PrimitiveIntegrationProviderResponse`
`items`	`FulfillmentItemResponse[]`
`requiredServices`	`FulfillmentProviderServiceTypeModel[]`
`requirements`	`FulfillmentRequirementTypeModel[]`
`collection`	`CollectionResponse`
`delivery`	`DeliveryResponse`
`totalDeclaredValue`	`number (double)`
`isInternational`	`boolean`
`isApprovedByUser`	`boolean`
`totalItems`	`integer (int32)`
`serviceLevelText`	`string`
`serviceLevel`	`enum ServiceLevel`	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`deliveryType`	`enum FulfillmentDeliveryType`	One of: `Unknown`, `DoorToDoor`, `DoorToCollectionPoint`, `CollectionPointToDoor`, `CollectionPointToCollectionPoint`, `DoorToPort`, `PortToDoor`, `PortToPort`, `LockerToLocker`.
`weightType`	`enum WeightType`	One of: `Unknown`, `Kilogram`, `Tonne`, `Pound`, `Stone`, `UsTon`, `ImperialTon`, `Gram`.
`lengthType`	`enum LengthType`	One of: `Unknown`, `Centimeter`, `Meter`, `Inch`, `Foot`.
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`dateOfEstimatedCollection`	`string (date-time)`	The estimated collection and delivery dates, when they are known. They are null when no estimate exists. Do not substitute today's date.
`dateOfEstimatedDelivery`	`string (date-time)`
`currency`	`CurrencyResponse`
`subTotal`	`number (double)`
`totalPrice`	`number (double)`
`totalTax`	`number (double)`
`totalDiscount`	`number (double)`
`discount`	`number (double)`
`discountType`	`enum DiscountType`	One of: `None`, `Percentage`, `FixedValue`.
`taxIncluded`	`boolean`
`shipment`	`ShipmentResponse`

ShipmentResponse

Field	Type	Description
`dateCreated`	`string (date-time)`
`dateModified`	`string (date-time)`
`id`	`string (uuid)`
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`status`	`enum ShipmentStatus`	One of: `Unknown`, `Active`, `PendingCollection`, `CollectionUnassigned`, `CollectionAssigned`, `CollectionRejected`, `CollectionException`, `CollectionFailedAttempt`, `Collected`, `AtHub`, `ReturnedToHub`, `InTransit`, `AtDestinationHub`, `DeliveryUnassigned`, `DeliveryAssigned`, `DeliveryRejected`, `DeliveryException`, `OutForDelivery`, `DeliveryFailedAttempt`, `InLocker`, `Delivered`, `Cancelled`.
`hasDimensions`	`boolean`
`dateOfDeparture`	`string (date-time)`
`title`	`string`	Limits: maximum 100 characters.
`providerServiceLevelId`	`Uid`
`providerServiceLevelIdType`	`enum UidType`	One of: `Unknown`, `Long`, `Guid`, `String`.
`serviceLevel`	`enum ServiceLevel`	One of: `Unknown`, `Standard`, `Express`, `SameDay`, `Overnight`, `TwoDay`, `InternationalStandard`, `InternationalExpress`, `OnDemand`, `Freight`.
`code`	`string`
`description`	`string`	Limits: maximum 3000 characters.
`handlingType`	`enum HandlingType`	One of: `Unknown`, `Delivery`, `Collection`, `Unassigned`.
`requiresApproval`	`boolean`
`totalDeclaredValue`	`number (double)`
`quantityOfItems`	`number (double)`
`trackingId`	`string`
`barcode`	`string`
`delivery`	`DeliveryResponse`
`collection`	`CollectionResponse`
`currency`	`CurrencyResponse`
`dispatch`	`DispatchResponse`
`business`	`BusinessResponse`
`customer`	`CustomerResponse`
`items`	`ShipmentItemResponse[]`
`fulfillmentContacts`	`ContactResponse[]`
`orderShipments`	`OrderShipmentResponse[]`
`waypoints`	`ShipmentWaypointResponse[]`
`metadata`	`map<string, string>`
`attachments`	`MetadataFileAttachment[]`

SupplierResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`description`	`string`
`contact`	`ContactResponse`
`addressId`	`string (uuid)`	Reference to the supplier's origin address (`business_addresses`), if set.
`address`	`AddressResponse`
`paymentTerms`	`string`	Free-text payment terms (e.g. "Net 30"). Display-only.
`defaultLeadTimeDays`	`integer (int32)`	Fallback lead time in days for suppliers with no purchase-order history yet.
`code`	`string`	Optional free-text internal reference code for the supplier (e.g. "SUP-001"). Display-only.
`defaultCurrency`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.

SymbolicLocaleMetadata

Field	Type	Description
`currency`	`string`
`country`	`string`
`weight`	`string`
`length`	`string`
`businessDefaultTypes`	`GeometryAndCountryMetadata`

UpdateOrderRequest

Field	Type	Description
`id`	`string (uuid)`
`description`	`string`
`currencyCode`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.
`status`	`enum OrderStatus`	One of: `Unknown`, `New`, `PendingCollection`, `PendingDelivery`, `Complete`, `Cancelled`, `PendingReturn`, `Returned`.
`fulfillmentType`	`enum FulfillmentType`	One of: `Unknown`, `Package`, `Pallet`, `Container`, `Miscellaneous`.
`fulfillmentSubType`	`enum FulfillmentSubType`	One of: `Unknown`, `GeneralPackage`, `FoodDelivery`, `MedicalDelivery`, `GroceriesDelivery`, `StandardPallet`, `StandardInternationalPallet`, `StandardUsPallet`, `StandardEuroPallet`, `CustomPallet`, `General10Ft`, `General20Ft`, `HighCube20Ft`, `General40Ft`, `HighCube40Ft`, `General45Ft`, `HighCube45Ft`, `FlatRack20FtWithSides`, `FlatRack20FtWithoutSides`, `FlatRack40FtWithSides`, `FlatRack40FtWithoutSides`, `OpenTop20Ft`, `OpenTop40Ft`, `Reefer20Ft`, `Reefer40Ft`, `MiniVan`, `DryVan`, `Flatbed`, `Tanker`, `AutoHauler`, `BoxTruck`, `Trailer`, `LowBoy`, `Dumper`, `Pickup`, `TowTruck`, `DumpTruck`.
`dateOfScheduledCollection`	`string (date-time)`
`paymentProcessed`	`boolean`
`paymentUrl`	`string`
`paymentMethod`	`enum PaymentMethod`	One of: `Unknown`, `Cash`, `Card`, `CashOnDelivery`, `CardOnDelivery`, `Eft`, `Crypto`, `Paypal`, `WireTransfer`, `DebitOrder`.

Triggers

The triggers operations of the Core API.

Product integration

Product-related integration endpoints