Fulfillment | Orders

List fulfillment orders of your customers

get

A fulfillment order represents a single order of a service or cancellation or change of an existing service instance (subscription).

These orders need to be fulfilled to process the lifecycle of the service instances.

For example, use the status filter to get open fulfillment orders that you then can process through the transition route.

You can only access orders of customers of your provider entity.

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

customersinteger · int32[]Optional

Filter the orders by one or more customer ids or names.

servicesinteger · int32[]Optional

Filter the orders by one or more ordered service ids.

orderstringOptional

Filter by the order number of the sales order.

externalIdsstring[]Optional

Filter by one or more external ids.

serviceCategoriesinteger · int32[]Optional

Filter by one or more service categories based on their id.

afterstring · date-timeOptional

Filter the orders created after the specified date.

beforestring · date-timeOptional

Filter the orders created before the specified date.

sortBystringOptional

Sort the results by a given criterion (customer|date).

Default: date

sortOrderstringOptional

Sort the results in a given order (asc|desc).

Default: desc

offsetinteger · int32Optional

Specifies the index of the first result to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of results to return (min: 1; max: 1000)

Default: 100

Responses

200

OK: List of fulfillment orders.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

get/v1/fulfillment/orders

HTTPcURLJavaScriptPython

GET /v1/fulfillment/orders HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "transactionType": "order",
      "status": "new",
      "fulfillmentType": "in-house",
      "isPreorder": true,
      "partnerNote": "Contract number: 154587858",
      "offer": {
        "id": 99,
        "type": "rental",
        "purchasePrice": 99.99,
        "recurringPrice": 19.99,
        "currency": "EUR",
        "subscriptionPeriod": 12,
        "name": "Summer Deal",
        "externalId": "W5A345",
        "isDefault": true,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "service": {
        "id": 4,
        "name": "Basic Plan",
        "category": "text",
        "ean": "0194253408253",
        "externalId": "E54363",
        "supplierName": "text",
        "previewImageLink": "text",
        "type": "service",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "options": [
        {
          "offer": {
            "id": 99,
            "purchasePrice": 99.99,
            "recurringPrice": 19.99,
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "option": {
            "id": 42,
            "name": "Color",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "version": {
            "id": 42,
            "name": "Red",
            "self": {
              "href": "text",
              "method": "text"
            }
          }
        }
      ],
      "order": {
        "id": 2324576,
        "customerOrderNumber": "RQ12345",
        "orderNumber": "4321",
        "created": "2021-06-08T11:34:30",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "customer": {
        "id": 4,
        "name": "foo Inc.",
        "customerNumber": "C00001",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "orderedBy": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "email": "[e-mail]",
        "phoneBusiness": "[phone]",
        "phoneMobile": "[phone]",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "deliveryAddress": {
        "line1": "equipme GmbH",
        "street": "W 55th St",
        "number": 240,
        "addition": "3rd floor",
        "city": "New York",
        "postalCode": 10019,
        "countryCode": "US",
        "regionCode": "NY",
        "regionName": "New York",
        "dependentLocality": "Chilmington Green",
        "phoneNumber": "[phone]",
        "id": 83,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "billingAddress": {
        "line1": "equipme GmbH",
        "street": "W 55th St",
        "number": 240,
        "addition": "3rd floor",
        "city": "New York",
        "postalCode": 10019,
        "countryCode": "US",
        "regionCode": "NY",
        "regionName": "New York",
        "dependentLocality": "Chilmington Green",
        "phoneNumber": "[phone]",
        "id": 83,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "preferredProvisionDate": "2026-07-15T13:36:07.469Z",
      "serviceInstance": {
        "id": 42,
        "inventoryNumber": "EQ642",
        "costCenter": "4645-2343",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "targetServiceInstance": {
        "id": 42,
        "service": {
          "id": 4,
          "name": "Basic Plan",
          "category": "text",
          "ean": "0194253408253",
          "externalId": "E54363",
          "supplierName": "text",
          "previewImageLink": "text",
          "type": "service",
          "self": {
            "href": "text",
            "method": "text"
          }
        },
        "metadata": [
          {
            "key": "Serial number",
            "value": "SN45346X2345",
            "scope": "public"
          }
        ],
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "assignments": {
        "location": {
          "id": 1,
          "name": "HQ New York",
          "type": "location",
          "self": {
            "href": "text",
            "method": "text"
          }
        },
        "employee": {
          "id": 1,
          "firstName": "Pierce",
          "lastName": "Bell",
          "email": "[e-mail]",
          "phoneBusiness": "[phone]",
          "phoneMobile": "[phone]",
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      },
      "bomItems": [
        {
          "quantity": 1,
          "product": {
            "id": 1,
            "name": "Basic Plan",
            "partNumber": "EQ-0001",
            "externalId": "3704e3bed2654eaf8222800068f62b56",
            "self": {
              "href": "text",
              "method": "text"
            }
          }
        }
      ],
      "totalRecurringPrice": 1,
      "totalPurchasePrice": 1,
      "id": 13,
      "externalId": "5214e3bed1454eaf",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single fulfillment order by its id.

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

orderIdinteger · int64Required

The identifier of the fulfillment order.

Responses

200

OK: The requested fulfillment order.

application/json

transactionTypestring · enumRequired

The action triggered by a fulfillment order.

Possible values:

statusstring · enumRequired

Status of the fulfillment process.

Possible values:

fulfillmentTypestring · enumOptional

Types of fulfillment to complete a customer order.

Possible values:

isPreorderbooleanOptional

Indicates whether this order is a preorder. Preorders should only be prepared until ready for delivery and then wait to be requested by the customer before shipment.

partnerNotestring · nullableOptional

A note shared with the intermediary partner. (Only for orders placed by partner customers)

Example: Contract number: 154587858

preferredProvisionDatestring · date-time · nullableOptional

The preferred provision date.

totalRecurringPricenumber · doubleOptional

Sum of the recurring prices of the service offer and the ordered options in this item.

totalPurchasePricenumber · doubleOptional

Sum of the purchase prices of the service offer and the ordered options in this item.

idinteger · int64Required

The identifier of the order.

Example: 13

externalIdstring · nullableOptional

The identifier of the order in an external app.

Example: 5214e3bed1454eaf

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

get/v1/fulfillment/orders/{orderId}

HTTPcURLJavaScriptPython

GET /v1/fulfillment/orders/{orderId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "transactionType": "order",
  "status": "new",
  "fulfillmentType": "in-house",
  "isPreorder": true,
  "partnerNote": "Contract number: 154587858",
  "offer": {
    "id": 99,
    "type": "rental",
    "purchasePrice": 99.99,
    "recurringPrice": 19.99,
    "currency": "EUR",
    "subscriptionPeriod": 12,
    "name": "Summer Deal",
    "externalId": "W5A345",
    "isDefault": true,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "service": {
    "id": 4,
    "name": "Basic Plan",
    "category": "text",
    "ean": "0194253408253",
    "externalId": "E54363",
    "supplierName": "text",
    "previewImageLink": "text",
    "type": "service",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "options": [
    {
      "offer": {
        "id": 99,
        "purchasePrice": 99.99,
        "recurringPrice": 19.99,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "option": {
        "id": 42,
        "name": "Color",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "version": {
        "id": 42,
        "name": "Red",
        "self": {
          "href": "text",
          "method": "text"
        }
      }
    }
  ],
  "order": {
    "id": 2324576,
    "customerOrderNumber": "RQ12345",
    "orderNumber": "4321",
    "created": "2021-06-08T11:34:30",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "customer": {
    "id": 4,
    "name": "foo Inc.",
    "customerNumber": "C00001",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "orderedBy": {
    "id": 1,
    "firstName": "Pierce",
    "lastName": "Bell",
    "email": "[e-mail]",
    "phoneBusiness": "[phone]",
    "phoneMobile": "[phone]",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "deliveryAddress": {
    "line1": "equipme GmbH",
    "street": "W 55th St",
    "number": 240,
    "addition": "3rd floor",
    "city": "New York",
    "postalCode": 10019,
    "countryCode": "US",
    "regionCode": "NY",
    "regionName": "New York",
    "dependentLocality": "Chilmington Green",
    "phoneNumber": "[phone]",
    "id": 83,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "billingAddress": {
    "line1": "equipme GmbH",
    "street": "W 55th St",
    "number": 240,
    "addition": "3rd floor",
    "city": "New York",
    "postalCode": 10019,
    "countryCode": "US",
    "regionCode": "NY",
    "regionName": "New York",
    "dependentLocality": "Chilmington Green",
    "phoneNumber": "[phone]",
    "id": 83,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "preferredProvisionDate": "2026-07-15T13:36:07.469Z",
  "serviceInstance": {
    "id": 42,
    "inventoryNumber": "EQ642",
    "costCenter": "4645-2343",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "targetServiceInstance": {
    "id": 42,
    "service": {
      "id": 4,
      "name": "Basic Plan",
      "category": "text",
      "ean": "0194253408253",
      "externalId": "E54363",
      "supplierName": "text",
      "previewImageLink": "text",
      "type": "service",
      "self": {
        "href": "text",
        "method": "text"
      }
    },
    "metadata": [
      {
        "key": "Serial number",
        "value": "SN45346X2345",
        "scope": "public"
      }
    ],
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "assignments": {
    "location": {
      "id": 1,
      "name": "HQ New York",
      "type": "location",
      "self": {
        "href": "text",
        "method": "text"
      }
    },
    "employee": {
      "id": 1,
      "firstName": "Pierce",
      "lastName": "Bell",
      "email": "[e-mail]",
      "phoneBusiness": "[phone]",
      "phoneMobile": "[phone]",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  },
  "bomItems": [
    {
      "quantity": 1,
      "product": {
        "id": 1,
        "name": "Basic Plan",
        "partNumber": "EQ-0001",
        "externalId": "3704e3bed2654eaf8222800068f62b56",
        "self": {
          "href": "text",
          "method": "text"
        }
      }
    }
  ],
  "totalRecurringPrice": 1,
  "totalPurchasePrice": 1,
  "id": 13,
  "externalId": "5214e3bed1454eaf",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Deprecated

Update a fulfillment order regarding context information like the external id. To update the status see transition endpoint. (deprecated - please use the PATCH route instead)

put

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

orderIdinteger · int64Required

The identifier of the order.

Body

application/json

externalIdstring · max: 100 · nullableOptional

The identifier of the order in an external app. Note: null value will be ignored on update. Set to empty string to clear a current value.

Example: 5214e3bed1454eaf

Responses

204

NoContent: Update successful.

No content

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

409

Conflict: Request conflicts with the current state of the server.

application/json

put/v1/fulfillment/orders/{orderId}

HTTPcURLJavaScriptPython

PUT /v1/fulfillment/orders/{orderId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "externalId": "5214e3bed1454eaf"
}

No content

Patch a fulfillment order regarding context information like the external id. To update the status see transition endpoint.

patch

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

orderIdinteger · int64Required

The identifier of the order.

Bodyobject · Operation[]

application/json

valueany · nullableOptional

pathstring · nullableOptional

opstring · nullableOptional

fromstring · nullableOptional

Responses

204

NoContent: Patch successful.

No content

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

patch/v1/fulfillment/orders/{orderId}

HTTPcURLJavaScriptPython

PATCH /v1/fulfillment/orders/{orderId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 280

[
  {
    "op": "add",
    "path": "/externalId",
    "value": "5214e3bed1454eaf"
  },
  {
    "op": "add",
    "path": "/fulfillmentType",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/partnerNote",
    "value": "Contract number: 154587858"
  },
  {
    "op": "add",
    "path": "/preferredProvisionDate",
    "value": "2026-07-15T12:31:34.4672687Z"
  }
]

No content

Update the fulfillment status of an order

post

To process the status of an order, cancellation or change, post a transition. This will process the lifecycle status of the related service instance (subscription).

See the schema of the request body below for allowed actions in the transition.

You can only access orders of customers of your provider entity.

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

orderIdinteger · int64Required

The identifier of the order.

Body

application/json

actionstring · enumRequired

The action to take on the fulfillment order.

Possible values:

activationDatestring · date-time · nullableOptional

The (UTC) date on which the service should be activated (time component is ignored). Only applicable for the complete action. If not provided, the service is activated immediately upon completion.

Responses

204

NoContent: Update successful.

No content

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

409

Conflict: Request conflicts with the current state of the server.

application/json

post/v1/fulfillment/orders/{orderId}/transitions

HTTPcURLJavaScriptPython

POST /v1/fulfillment/orders/{orderId}/transitions HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "action": "process",
  "activationDate": "2026-07-15T13:36:07.469Z"
}

No content