HighLevel: Create order fulfillment

← Payments operations · Get started

Operation gohighlevel.create_order_fulfillment

Provider route: POST /payments/orders/{orderId}/fulfillments. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["payments"]["createOrderFulfillment"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.payments.createOrderFulfillment(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.payments.create_order_fulfillment(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.orderId	string	Required within parent
body	Model	Required within parent	Expand Create order fulfillment — request body — body

Referenced models: Create order fulfillment — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create order fulfillment — response body

Referenced models: Create order fulfillment — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Create order fulfillment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
items	array	Required within parent	Fulfilled items
items[]	Model	Each item	Expand Create order fulfillment — request body — body items item
notifyCustomer	boolean	Required within parent	Need to send a notification to customer
trackings	array	Required within parent	Fulfillment tracking information
trackings[]	Model	Each item	Expand Create order fulfillment — request body — body trackings item

Referenced models: Create order fulfillment — request body — body items item, Create order fulfillment — request body — body trackings item

Create order fulfillment — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	fulfillment data
data (allOf 1)	Model	All variants apply	Expand List fulfillment — response body — data item
status	boolean	Required within parent	Status of api action

Referenced models: List fulfillment — response body — data item

Create order fulfillment — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
priceId	string	Required within parent	The id of product price
qty	number	Required within parent	The no of quantity of the item

Create order fulfillment — request body — body trackings item

Field	Type	Presence	Description and constraints
$	object	Root
shippingCarrier	string	Optional	Shipping carrier name
trackingNumber	string	Optional	Tracking number provided by the shipping carrier
trackingUrl	string	Optional	Tracking URL

List fulfillment — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the fulfillment item.
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
createdAt	string	Required within parent	created at
items	array	Required within parent	Fulfilled items
items[]	Model	Each item	Expand List fulfillment — response body — data item items item
trackings	array	Required within parent	Fulfillment tracking information
trackings[]	Model	Each item	Expand Create order fulfillment — request body — body trackings item
updatedAt	string	Required within parent	updated at

Referenced models: Create order fulfillment — request body — body trackings item, List fulfillment — response body — data item items item

List fulfillment — response body — data item items item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The id of product price
name	string	Required within parent	Name
price	JSON	Required within parent	Price details
price (allOf 1)	Model	All variants apply	Expand Create Price for a Product — response body
product	JSON	Required within parent	Product details
product (allOf 1)	Model	All variants apply	Expand Create Product — response body
qty	JSON	Required within parent
qty (anyOf 1)	number	Alternative	The no of quantity of the current fulfilled item
qty (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create Product — response body, Create Price for a Product — response body

Create Product — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the product.
automaticTaxCategoryId	string	Optional	Tax category ID for Automatic taxes calculation.
availableInStore	boolean	Optional	Indicates whether the product is available in-store.
collectionIds	array	Optional	An array of category Ids for the product
collectionIds[]	string	Each item
createdAt	string	Required within parent	The creation timestamp of the product. Format: date-time
description	string	Optional	product description
image	string	Optional	The URL for the product image.
isTaxesEnabled	boolean	Optional	The field indicates whether taxes are enabled for the product or not. Default: false
label	JSON	Optional	The Product label details
label (allOf 1)	Model	All variants apply	Expand Create Product — response body — label end Date, start Date, title
locationId	string	Required within parent	The unique identifier for the location.
name	string	Required within parent	The name of the product.
productType	string	Required within parent	The type of the product (e.g., PHYSICAL).
slug	string	Optional	The slug of the product by which the product will be navigated
statementDescriptor	string	Optional	The statement descriptor for the product.
taxes	array	Optional	An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.
taxes[]	string	Each item
updatedAt	string	Required within parent	The last update timestamp of the product. Format: date-time
variants	array	Optional	An array of variants for the product.
variants[]	Model	Each item	Expand Create Product — response body — variants item

Referenced models: Create Product — response body — label end Date, start Date, title, Create Product — response body — variants item

Create Product — response body — label end Date, start Date, title

Field	Type	Presence	Description and constraints
$	object	Root
endDate	string	Optional	Start date in YYYY-MM-DDTHH:mm:ssZ format
startDate	string	Optional	Start date in YYYY-MM-DDTHH:mm:ssZ format
title	string	Required within parent	The content for the product label.

Create Product — response body — variants item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	A unique identifier for the variant.
name	string	Required within parent	The name of the variant.
options	array	Required within parent	An array of options for the variant.
options[]	Model	Each item	Expand Create Product — response body — variants item options item

Referenced models: Create Product — response body — variants item options item

Create Price for a Product — response body — membership Offers item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the membership offer.
label	string	Required within parent	Membership offer label
value	string	Required within parent	Membership offer label

Create Price for a Product — response body — recurring / interval: day, month, week, year

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	The interval at which the recurring event occurs. Known values: day, month, week, year
intervalCount	JSON	Required within parent
intervalCount (anyOf 1)	number	Alternative	The number of intervals between each occurrence of the event.
intervalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_order_fulfillment. Catalog operation: create-order-fulfillment. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["payments/orders.write"]

Pinned headers: {"Version": "v3"}

Official provider source