Order

Version 1.0

The Order Entity stands as the linchpin in our platform, serving as the focal point for orchestrating seamless transactions within marketplaces. Crafted to be the central nerve center for all order-related operations, this entity empowers merchants with a robust and dynamic framework for managing transactions across diverse channels. From essential details such as order status, customer information, and payment details to more intricate elements like shipping preferences and order history, the Order Entity captures and organizes a comprehensive array of data with precision. Going beyond mere transaction tracking, it forms the backbone of a well-coordinated marketplace ecosystem, ensuring coherence and accuracy across all transaction touchpoints.

The Order Entity plays a pivotal role in streamlining the order fulfillment process, facilitating efficient communication between merchants, customers, and other stakeholders. Its meticulous organization of data enables merchants to confidently navigate the complexities of order management, ultimately enhancing the overall customer experience. As the authoritative source of truth for transactions, the Order Entity fosters trust and reliability in the marketplace, providing a sturdy foundation for successful e-commerce operations.

# Endpoints
POST
/v1/orders# Create a single order
GET
/v1/orders/123456789# Retrieve a single order
PATCH
/v1/orders/123456789# Update a single order
DELETE
/v1/orders/123456789# Delete a single order

Order Entity

  • Name
    id
    Type
    string
    Required
    Description

    Every order is assigned a unique identifier - an unsigned 64-bit integer known as the Order ID. This specific number is exclusive and distinct across the entire Qooly platform, ensuring an unparalleled level of uniqueness for each order.

  • Name
    connection_id
    Type
    foreignId
    Required
    Description

    This property indicates the connection associated with the order. It serves as a unique identifier, specific to each connection (e.g., Amazon, Shopify) in Qooly's system. The 'connection_id' provides a reliable reference to the platform through which the order was processed.

  • Name
    currency_id
    Type
    foreignId
    Required
    Description

    This property indicates the currency used for the order. It serves as a unique identifier, specific to each currency in Qooly's system. The 'currency_id' provides a reliable reference to the currency in which the order's total price is expressed, ensuring accurate financial transactions.

  • Name
    customer_id
    Type
    foreignId
    Required
    Description

    This serves as a unique identifier for each customer placing an order in Qooly's system. As a distinct numerical value, the 'customer_id' provides a reliable reference to every individual customer, facilitating seamless order tracking and management.

  • Name
    total
    Type
    decimal
    Required
    Description

    This property indicates the total price of the order, considering the quantity and any applicable taxes or discounts.

  • Name
    tax_total
    Type
    decimal
    Required
    Description

    This property indicates the total tax applied of the order.

  • Name
    payment_status
    Type
    varchar(16)
    Default: PENDING
    Description

    This property indicates the payment status of the order.

    PendingThe payment for the order is pending.
    PaidThe payment for the order has been successfully processed.
    FailedThe payment for the order has failed.
  • Name
    order_status
    Type
    varchar(16)
    Default: PROCESSING
    Description

    This property indicates the status of the order.

    ProcessingThe order is currently being processed.
    ShippedThe order has been shipped to the customer.
    DeliveredThe order has been successfully delivered.
    CancelledThe order has been cancelled.
  • Name
    fulfillment_status
    Type
    varchar(16)
    Default: PENDING
    Description

    This property indicates the fulfillment status of the order.

    PendingThe order is pending fulfillment.
    FulfilledThe order has been fulfilled.
    Partially FulfilledThe order has been partially fulfilled.
  • Name
    delivery_method
    Type
    varchar(16)
    Default: STANDARD
    Description

    This property indicates the delivery method of the order.

    StandardThe order is being shipped using standard delivery.
    ExpressThe order is being shipped using express delivery.
  • Name
    items_count
    Type
    integer
    Required
    Description

    This property indicates the total number of items in the order.

  • Name
    original_order_data
    Type
    json
    Description

    This property indicates the original order data.

  • Name
    created_at
    Type
    timestamp
    Description

    This property indicates the time in ISO_8601 when the order was created.

  • Name
    updated_at
    Type
    timestamp
    Description

    This property indicates the time in ISO_8601 when the order was last updated.

  • Name
    created_by
    Type
    foreignId
    Description

    This property indicates the user who created the order.

  • Name
    updated_by
    Type
    foreignId
    Description

    This property indicates the user who updated the order recently.

The Order resource

JSON
{
"id": "123456789",
"connection_id": "987654321",
"currency_id": "456789012",
"customer_id": "789012345",
"total": 150.25,
"tax_total": 15.00,
"payment_status": "Paid",
"order_status": "Shipped",
"fulfillment_status": "Fulfilled",
"delivery_method": "Standard",
"items_count": 3,
"original_order_data": {
"order_number": "ORD123456",
"payment_method": "Credit Card",
"shipping_address": {
"street": "123 Main St",
"city": "Cityville",
"state": "CA",
"zip_code": "12345",
"country": "US"
},
"billing_address": {
"street": "456 Billing St",
"city": "Billingtown",
"state": "CA",
"zip_code": "54321",
"country": "US"
},
"order_items": [
{
  "product_id": "789",
  "quantity": 2,
  "unit_price": 49.99
},
{
  "product_id": "456",
  "quantity": 1,
  "unit_price": 29.99
}
]
},
"created_at": "2024-01-15T10:45:00Z",
"updated_at": "2024-01-16T14:30:00Z",
"created_by": "789012345",
"updated_by": "123456789"
}

Create a single order

This endpoint allows you to create a single order.

Required Fields

  • Name
    customer_id
    Type
    foreignId
    Required
    Description
  • Name
    total
    Type
    decimal
    Required
    Description
  • Name
    payment_status
    Type
    varchar(16)
    Default: PENDING
    Description
    PendingThe payment for the order is pending.
    PaidThe payment for the order has been successfully processed.
    FailedThe payment for the order has failed.
  • Name
    order_status
    Type
    varchar(16)
    Default: PROCESSING
    Description
    ProcessingThe order is currently being processed.
    ShippedThe order has been shipped to the customer.
    DeliveredThe order has been successfully delivered.
    CancelledThe order has been cancelled.
  • Name
    fulfillment_status
    Type
    varchar(16)
    Default: PENDING
    Description
    PendingThe order is pending fulfillment.
    FulfilledThe order has been fulfilled.
    Partially FulfilledThe order has been partially fulfilled.
  • Name
    delivery_method
    Type
    varchar(16)
    Default: STANDARD
    Description
    StandardThe order is being shipped using standard delivery.
    ExpressThe order is being shipped using express delivery.
  • Name
    items_count
    Type
    integer
    Required
    Description
  • Name
    original_order_data
    Type
    json
    Description

Examples

Create a single order

POST
/v1/orders
curl --request POST \
  --url https://api.qooly.io/v1/orders \
  --header 'Content-Type: application/json' \
  --data '{
    "customer_id": "789012345",
    "total": 150.25,
    "payment_status": "Pending",
    "order_status": "Processing",
    "fulfillment_status": "Pending",
    "delivery_method": "Standard",
    "items_count": 3,
    "original_order_data": {
      "order_number": "ORD123456",
      "payment_method": "Credit Card",
      "shipping_address": {
        "street": "123 Main St",
        "city": "Cityville",
        "state": "CA",
        "zip_code": "12345",
        "country": "US"
      },
      "billing_address": {
        "street": "456 Billing St",
        "city": "Billingtown",
        "state": "CA",
        "zip_code": "54321",
        "country": "US"
      },
      "items": [
        {"product_id": "789", "quantity": 2, "unit_price": 49.99},
        {"product_id": "456", "quantity": 1, "unit_price": 29.99}
      ]
    }
  }'

Create a single order

POST
/v1/orders
curl --request POST \
  --url https://api.qooly.io/v1/orders \
  --header 'Content-Type: application/json' \
  --data '{
    "customer_id": "789012345",
    "total": 150.25,
    "payment_status": "Pending",
    "order_status": "Processing",
    "fulfillment_status": "Pending",
    "delivery_method": "Standard",
    "items_count": 3,
    "original_order_data": {
      "order_number": "ORD123456",
      "payment_method": "Credit Card",
      "shipping_address": {
        "street": "123 Main St",
        "city": "Cityville",
        "state": "CA",
        "zip_code": "12345",
        "country": "US"
      },
      "billing_address": {
        "street": "456 Billing St",
        "city": "Billingtown",
        "state": "CA",
        "zip_code": "54321",
        "country": "US"
      },
      "items": [
        {"product_id": "789", "quantity": 2, "unit_price": 49.99},
        {"product_id": "456", "quantity": 1, "unit_price": 29.99}
      ]
    }
  }'
JSON
{
  "id": "987654321",
  "customer_id": "789012345",
  "total": 150.25,
  "payment_status": "Pending",
  "order_status": "Processing",
  "fulfillment_status": "Pending",
  "delivery_method": "Standard",
  "items_count": 3,
  "original_order_data": {
    "order_number": "ORD123456",
    "payment_method": "Credit Card",
    "shipping_address": {
      "street": "123 Main St",
      "city": "Cityville",
      "state": "CA",
      "zip_code": "12345",
      "country": "US"
    },
    "billing_address": {
      "street": "456 Billing St",
      "city": "Billingtown",
      "state": "CA",
      "zip_code": "54321",
      "country": "US"
    },
    "items": [
      {"product_id": "789", "quantity": 2, "unit_price": 49.99},
      {"product_id": "456", "quantity": 1, "unit_price": 29.99}
    ]
  },
  "created_at": "2024-01-19T10:45:00Z",
  "created_by": "789012345",
}

Retrieve a single order

This endpoint allows you to retrieve a single order.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Retrieve a single order

GET
/v1/orders/987654321
curl --request GET \
  --url https://api.qooly.io/v1/orders/987654321

Retrieve a single order

GET
/v1/orders/987654321
curl --request GET \
  --url https://api.qooly.io/v1/orders/987654321
JSON
{
  "id": "987654321",
  "connection_id": "123456789",
  "currency_id": "456789012",
  "customer_id": "789012345",
  "total": 150.25,
  "tax_total": 25.50,
  "payment_status": "Pending",
  "order_status": "Processing",
  "fulfillment_status": "Pending",
  "delivery_method": "Standard",
  "items_count": 3,
  "original_order_data": {
    "order_number": "ORD123456",
    "payment_method": "Credit Card",
    "shipping_address": {
      "street": "123 Main St",
      "city": "Cityville",
      "state": "CA",
      "zip_code": "12345",
      "country": "US"
    },
    "billing_address": {
      "street": "456 Billing St",
      "city": "Billingtown",
      "state": "CA",
      "zip_code": "54321",
      "country": "US"
    },
    "items": [
      {"product_id": "789", "quantity": 2, "unit_price": 49.99},
      {"product_id": "456", "quantity": 1, "unit_price": 29.99}
    ]
  },
  "created_at": "2024-01-19T10:45:00Z",
  "updated_at": "2024-01-19T12:30:00Z",
  "created_by": "789012345",
  "updated_by": "987654321"
}

Update a single order

This endpoint allows you to update a single order.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Update a single order

PATCH
/v1/orders/987654321
curl --request PATCH \
  --url https://api.qooly.io/v1/orders/987654321 \
  --header 'Content-Type: application/json' \
  --data '{
    "total": 175.99,
    "order_status": "Shipped"
  }'

Update a single order

PATCH
/v1/orders/987654321
curl --request PATCH \
  --url https://api.qooly.io/v1/orders/987654321 \
  --header 'Content-Type: application/json' \
  --data '{
    "total": 175.99,
    "order_status": "Shipped",
    "fulfillment_status": "Fulfilled",
    "delivery_method": "Express"
  }'

Update a single order

PATCH
/v1/orders/987654321
curl --request PATCH \
  --url https://api.qooly.io/v1/orders/987654321 \
  --header 'Content-Type: application/json' \
  --data '{
    "total": 175.99
  }'
JSON
{
  "id": "987654321",
  "connection_id": "123456789",
  "currency_id": "456789012",
  "customer_id": "789012345",
  "total": 175.99,
  "tax_total": 25.50,
  "payment_status": "Pending",
  "order_status": "Shipped",
  "fulfillment_status": "Fulfilled",
  "delivery_method": "Express",
  "items_count": 3,
  "original_order_data": {
    "order_number": "ORD123456",
    "payment_method": "Credit Card",
    "shipping_address": {
      "street": "123 Main St",
      "city": "Cityville",
      "state": "CA",
      "zip_code": "12345",
      "country": "US"
    },
    "billing_address": {
      "street": "456 Billing St",
      "city": "Billingtown",
      "state": "CA",
      "zip_code": "54321",
      "country": "US"
    },
    "items": [
      {"product_id": "789", "quantity": 2, "unit_price": 49.99},
      {"product_id": "456", "quantity": 1, "unit_price": 29.99}
    ]
  },
  "created_at": "2024-01-19T10:45:00Z",
  "updated_at": "2024-01-19T14:30:00Z",
  "created_by": "789012345",
  "updated_by": "987654321"
}

Delete a single order

This endpoint allows you to delete a single order.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Delete a single order

DELETE
/v1/orders/987654321
curl --request DELETE \
  --url https://api.qooly.io/v1/orders/987654321

Delete a single order

DELETE
/v1/orders/987654321
curl --request DELETE \
  --url https://api.qooly.io/v1/orders/987654321
JSON
{}