v1

latestOpenAPI 3.0.0Apache 2.02026-07-13775178.3 KB

Orders

List Orders

get/ecommerce/orders

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

cursorstring nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger

Number of results to return. Minimum 1, Maximum 200, Default 20

emailstring

Customer email address to filter on

customer_idstring

Customer id to filter on

updated_sincestring

Minimum date the order was last modified

created_sincestring

Minimum date the order was created

Apply filters

{
  "email": "elon@musk.com",
  "customer_id": "123",
  "updated_since": "2020-09-30T07:43:32.000Z",
  "created_since": "2020-09-30T07:43:32.000Z"
}

by'created_at' | 'updated_at' | 'name'

The field on which to sort the Orders

direction'asc' | 'desc'

The direction in which to sort the results

Apply sorting

{
  "by": "created_at",
  "direction": "desc"
}

example_downstream_propertystring

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

{
  "search": "San Francisco"
}

fieldsstring nullable

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Response

Orders

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "shopify",
  "resource": "orders",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "order_number": "123456789",
      "currency": "USD",
      "discounts": [
        {
          "code": "SUMMER20",
          "amount": "5.99",
          "percentage": "0.1"
        }
      ],
      "sub_total": "45.17",
      "shipping_cost": "5.17",
      "coupon_discount": "5.5",
      "total_discount": "5.5",
      "total_tax": "5.16",
      "total_amount": "50.17",
      "refunded_amount": "5.5",
      "tax_inclusive": true,
      "status": "active",
      "payment_status": "paid",
      "fulfillment_status": "shipped",
      "payment_method": "credit_card",
      "customer": {
        "id": "12345",
        "name": "John Doe",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "Acme Inc.",
        "phone_numbers": [
          {
            "id": "12345",
            "country_code": "1",
            "area_code": "323",
            "number": "111-111-1111",
            "extension": "105",
            "type": "primary"
          }
        ],
        "emails": [
          {
            "id": "123",
            "email": "elon@musk.com",
            "type": "primary"
          }
        ]
      },
      "billing_address": {
        "line1": "123 Main Street",
        "line2": "Apt 1",
        "company_name": "Acme Inc.",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "US"
      },
      "shipping_address": {
        "line1": "123 Main Street",
        "line2": "Apt 1",
        "company_name": "Acme Inc.",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "US"
      },
      "tracking": [
        {
          "provider": "UPS",
          "number": "1Z9999999999999999",
          "url": "https://www.ups.com/track?tracknum=1Z9999999999999999",
          "updated_at": "2020-09-30T07:43:32.000Z"
        }
      ],
      "line_items": [
        {
          "id": "12345",
          "product_id": "def456",
          "variant_id": "ghi789",
          "sku": "MBP123-16GB-SILVER-13",
          "name": "Midnight 16inch MacBook Pro",
          "description": "Powerful and portable, the MacBook Pro is perfect for professionals and creatives.",
          "options": [
            {
              "id": "jkl012",
              "name": "Color",
              "value": "Silver"
            }
          ],
          "quantity": "2",
          "unit_price": "19.99",
          "tax_rate": "0.08",
          "tax_amount": "1.6",
          "refunded_amount": "0",
          "refunded_quantity": "0",
          "sub_total": "43.18",
          "total_amount": "43.18",
          "discounts": [
            {
              "code": "SUMMER20",
              "amount": "5.99",
              "percentage": "0.1"
            }
          ]
        }
      ],
      "note": "Special instructions for delivery",
      "refunds": [
        {
          "id": "12345",
          "amount": "100",
          "currency": "USD",
          "reason": "Customer requested a refund",
          "created_at": "2020-09-30T07:43:32.000Z"
        }
      ],
      "created_at": "2020-09-30T07:43:32.000Z",
      "updated_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

All 7 operations