Update Source
https://api.flxpoint.com/source/{id}Use this when you want to update source data through the API.
This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.
This endpoint allows you to update metadata associated to a Source.
To use this endpoint, simply specify the parameter you'd like to patch. Only the parameters the are passed will be patched.
Request
namequerystringThe name of the Source.
vendorIdqueryintegerThe vendor associated to a Source
commitStockquerybooleanThe setting that controls whether or not committed stock is enabled for this Source.
addressIdqueryintegerThe ID of the Address associated with a Source
rateShoppingquerybooleanThe setting that determines if this Source attempts to use Rate Shopping (for all requirements of Rate Shopping, see https://docs.flxpoint.com/flxpoint/rate-shopping)
releaseCommittedStockOnShipmentAddedquerybooleandeprecated**(This setting is deprecated, please reach out to our team before using)** If `true`, committed stock will be released as soon as Shipments are added. If `false`, committed stock will be released after Shipments are added AND Inventory quantity changes.
allowBackordersquerybooleanIt will allow the variants to be fulfilled/routed to during PO generation regardless of whether or not it is in stock.
typeIdqueryintegerThe ID of the Source Type that best fits this Source.
releaseCommittedStockOnQuantityUpdatequerybooleandeprecated**(This setting is deprecated, please reach out to our team before using)** If `true`, committed stock will be released as soon as inventory variant quantity is changed. If `false`, committed stock will be released after Shipments are added AND Inventory quantity changes.
containsFirearmsquerybooleanIndicates whether the source can contain firearms
containsFirearmsWorkflowEventIdqueryintegerThe ID of the workflow that determines whether or not a purchase order needs FFL information before being processed
Example request
/source/{id}curl -X PATCH "https://api.flxpoint.com/source/{id}" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN"Responses
200OKapplication/json
idintegerrequirednamestringdescriptionstringinsertedAtstring (date-time)addressIdintegerrateShoppingbooleanreleaseCommittedStockOnShipmentAddedbooleandeprecatedreleaseCommittedStockOnQuantityUpdatebooleandeprecatedvendorIdintegertypeobjectidintegernamestringData SourceInternal WarehouseExternal WarehouseVendor Warehousehandlestringdata_sourceinternal_warehouseexternal_warehousevendor_warehousecurrencyobjectidintegerrequiredcodestringrequirednamestringsymbolstringunicodeDecimalstringaddressobjectidintegernamestringaddressLine1stringaddressLine2stringcitystringstatestringcountrystringstateCodestringcountryCodestringpostalstringemailstringphonestringcompanyNamestringfirstNamestringlastNamestringredactedbooleanhashstringcommitStockbooleanallowBackordersbooleanvendorobjectidintegercreatedByUserIdintegercreatedAtstring (date-time)deletedAtstring (date-time)namestringdescriptionstringportalEnabledbooleancontainsFirearmsWorkflowEventIdintegercontainsFirearmsbooleanshippingCostWorkflowEventIdintegerdropshipFeeWorkflowEventIdintegerintegrationsarray[any]settingsarray[SourceSetting]idintegerrequiredsettingobjectrequiredidintegernamestringrequiredhandlestringrequiredtypestringrequiredimgbooleantime_interval_thresholdemailstringtextselectnumberradiomultijsonvalueTypestringrequiredintegerbooleantime_interval_thresholdstringselectemaildecimalnumbermultijsonplaceholderstringdefaultValuestringdescriptionstringoptionsstringparentSettingIdintegercategoryobjectidintegerhandlestringsupplier.settingsdealer.invoice.settingsaccount.settingsnotificationsaccount.b2bchannel.settingsfeature_flagsdealer.channel.settingssource.settingsvendor.settingsnamestringsourceIdintegervaluestringrequiredinsertedAtstring (date-time)updatedAtstring (date-time)autoCreateListingsWorkflowEventIdintegerautoRebuildEnabledOnstring (date-time)autoRebuildConfirmedByUserstringautoListEnabledOnstring (date-time)autoListConfirmedByUserstringautoCreateListingsForAllInventoriesbooleanautoCreateListingsForSpecificInventoriesbooleanautoGenerateInvoiceWorkflowIdinteger{
"id": 0,
"name": "string",
"description": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"addressId": 0,
"rateShopping": true,
"releaseCommittedStockOnShipmentAdded": true,
"releaseCommittedStockOnQuantityUpdate": true,
"vendorId": 0,
"type": {
"id": 0,
"name": "Data Source",
"handle": "data_source"
},
"currency": {
"id": 0,
"code": "string",
"name": "string",
"symbol": "string",
"unicodeDecimal": "string"
},
"address": {
"id": 0,
"name": "Joe Smith",
"addressLine1": "120 1st Lane",
"addressLine2": "Suite 123",
"city": "Jacksonville",
"state": "Florida",
"country": "United States",
"stateCode": "FL",
"countryCode": "US",
"postal": "12345",
"email": "person@example.com",
"phone": "1-555-123-4567",
"companyName": "string",
"firstName": "Joe",
"lastName": "Smith",
"redacted": true,
"hash": "string"
},
"commitStock": true,
"allowBackorders": true,
"vendor": {
"id": 0,
"createdByUserId": 0,
"createdAt": "2026-04-20T00:00:00Z",
"deletedAt": "2026-04-20T00:00:00Z",
"name": "string",
"description": "string",
"portalEnabled": true
},
"containsFirearmsWorkflowEventId": 0,
"containsFirearms": true,
"shippingCostWorkflowEventId": 0,
"dropshipFeeWorkflowEventId": 0,
"integrations": [
null
],
"settings": [
{
"id": 0,
"setting": {
"id": 0,
"name": "string",
"handle": "string",
"type": "img",
"valueType": "integer",
"placeholder": "string",
"defaultValue": "string",
"description": "string",
"options": "string",
"parentSettingId": 0,
"category": {
"id": null,
"handle": null,
"name": null
}
},
"sourceId": 0,
"value": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z"
}
],
"autoCreateListingsWorkflowEventId": 0,
"autoRebuildEnabledOn": "2026-04-20T00:00:00Z",
"autoRebuildConfirmedByUser": "string",
"autoListEnabledOn": "2026-04-20T00:00:00Z",
"autoListConfirmedByUser": "string",
"autoCreateListingsForAllInventories": true,
"autoCreateListingsForSpecificInventories": true,
"autoGenerateInvoiceWorkflowId": 0
}400Bad Request
No schema documented for this status.
401Not Found
No schema documented for this status.
404Not Found
No schema documented for this status.
OpenAPI fragment
{
"patch": {
"summary": "Update Source",
"description": "This endpoint allows you to update metadata associated to a Source. \n\nTo use this endpoint, simply specify the parameter you'd like to patch. Only the parameters the are passed will be patched. ",
"parameters": [
{
"schema": {
"type": "string"
},
"in": "query",
"name": "name",
"description": "The name of the Source."
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "vendorId",
"description": "The vendor associated to a Source"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "commitStock",
"description": "The setting that controls whether or not committed stock is enabled for this Source. "
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "addressId",
"description": "The ID of the Address associated with a Source"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "rateShopping",
"description": "The setting that determines if this Source attempts to use Rate Shopping (for all requirements of Rate Shopping, see https://docs.flxpoint.com/flxpoint/rate-shopping)"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "releaseCommittedStockOnShipmentAdded",
"description": "**(This setting is deprecated, please reach out to our team before using)** If `true`, committed stock will be released as soon as Shipments are added. If `false`, committed stock will be released after Shipments are added AND Inventory quantity changes.",
"deprecated": true
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "allowBackorders",
"description": "It will allow the variants to be fulfilled/routed to during PO generation regardless of whether or not it is in stock."
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "typeId",
"description": "The ID of the Source Type that best fits this Source."
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "releaseCommittedStockOnQuantityUpdate",
"description": "**(This setting is deprecated, please reach out to our team before using)** If `true`, committed stock will be released as soon as inventory variant quantity is changed. If `false`, committed stock will be released after Shipments are added AND Inventory quantity changes.",
"deprecated": true
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "containsFirearms",
"description": "Indicates whether the source can contain firearms"
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "containsFirearmsWorkflowEventId",
"description": "The ID of the workflow that determines whether or not a purchase order needs FFL information before being processed"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Source"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Not Found"
},
"404": {
"description": "Not Found"
}
}
}
}