/organization/wrap/{wrapId}/update v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Wraps
postOrganizationWrapIdUpdate
Code samples
const inputBody = '{
"type": "object",
"properties": {
"priority": {
"type": "string",
"nullable": true,
"description": "The priority of the item (e.g., 'recommended', 'optional', 'not recommended')."
},
"costCurrency": {
"type": "string",
"nullable": true,
"description": "The currency for the cost of the item."
},
"unitOfMeasure": {
"type": "string",
"nullable": true,
"description": "The unit of measure for the item."
},
"listPriceCurrency": {
"type": "string",
"nullable": true,
"description": "The currency for the list price of the item."
},
"listPriceUnitOfMeasure": {
"type": "string",
"nullable": true,
"description": "The unit of measure for the list price of the item."
},
"itemType": {
"type": "string",
"nullable": true,
"description": "The type of the item (e.g., 'otherItem', 'ferrule', 'adaptor', 'hose', 'crimpFitting')."
},
"orgPartNumber": {
"type": "string",
"nullable": true,
"description": "The organization part number of the item."
},
"recordSource": {
"type": "string",
"nullable": true,
"description": "Used to identify if the record was created by an import."
},
"available": {
"type": "boolean",
"nullable": true,
"description": "Indicates if the item is available."
},
"cost": {
"type": "number",
"format": "float",
"nullable": true,
"description": "The cost of the item."
},
"listPrice": {
"type": "number",
"format": "float",
"nullable": true,
"description": "The list price of the item."
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://goldleaf.app/api/v1/organization/wrap/{wrapId}/update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /organization/wrap/{wrapId}/update
Updates an item's properties
Updates an item's properties.
Body parameter
{
"type": "object",
"properties": {
"priority": {
"type": "string",
"nullable": true,
"description": "The priority of the item (e.g., 'recommended', 'optional', 'not recommended')."
},
"costCurrency": {
"type": "string",
"nullable": true,
"description": "The currency for the cost of the item."
},
"unitOfMeasure": {
"type": "string",
"nullable": true,
"description": "The unit of measure for the item."
},
"listPriceCurrency": {
"type": "string",
"nullable": true,
"description": "The currency for the list price of the item."
},
"listPriceUnitOfMeasure": {
"type": "string",
"nullable": true,
"description": "The unit of measure for the list price of the item."
},
"itemType": {
"type": "string",
"nullable": true,
"description": "The type of the item (e.g., 'otherItem', 'ferrule', 'adaptor', 'hose', 'crimpFitting')."
},
"orgPartNumber": {
"type": "string",
"nullable": true,
"description": "The organization part number of the item."
},
"recordSource": {
"type": "string",
"nullable": true,
"description": "Used to identify if the record was created by an import."
},
"available": {
"type": "boolean",
"nullable": true,
"description": "Indicates if the item is available."
},
"cost": {
"type": "number",
"format": "float",
"nullable": true,
"description": "The cost of the item."
},
"listPrice": {
"type": "number",
"format": "float",
"nullable": true,
"description": "The list price of the item."
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| wrapId | path | string(mongo-id) | true | The MongoDB ID of the item. |
| body | body | object | true | none |
| » priority | body | string¦null | false | The priority of the item (e.g., 'recommended', 'optional', 'not recommended'). |
| » costCurrency | body | string¦null | false | The currency for the cost of the item. |
| » unitOfMeasure | body | string¦null | false | The unit of measure for the item. |
| » listPriceCurrency | body | string¦null | false | The currency for the list price of the item. |
| » listPriceUnitOfMeasure | body | string¦null | false | The unit of measure for the list price of the item. |
| » itemType | body | string¦null | false | The type of the item (e.g., 'otherItem', 'ferrule', 'adaptor', 'hose', 'crimpFitting'). |
| » orgPartNumber | body | string¦null | false | The organization part number of the item. |
| » recordSource | body | string¦null | false | Used to identify if the record was created by an import. |
| » available | body | boolean¦null | false | Indicates if the item is available. |
| » cost | body | number(float)¦null | false | The cost of the item. |
| » listPrice | body | number(float)¦null | false | The list price of the item. |
Example responses
500 Response
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Unexpected error occurred"
},
"details": {
"type": "object",
"nullable": true
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The updated item properties | None |
| 500 | Internal Server Error | Internal server error | Inline |
Response Schema
Status Code 500
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » message | string | false | none | none |
| » details | object¦null | false | none | none |
