Glue API: Update shipment types
Edit on GitHubThis endpoint lets you update shipment types.
Installation
Update a shipment type
PATCH
/shipment-types
Request
HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION |
---|---|---|---|
Authorization | string | ✓ | Alphanumeric string that authorizes the warehouse user to send requests to protected resources. Get it by authenticating as a warehouse user. |
Request sample: PATCH https://glue-backend.mysprykershop.com/shipment-types/fa575a58-5119-5407-a00b-d1aa01fec63d
{
"data": {
"type": "shipment-types",
"attributes": {
"name": "Curbside pickup",
"key": "c-pickup",
"isActive": "false",
"stores": ["DE", "AT"]
}
}
}
ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
name | String | You will use it as a reference when adding shipment types to offers in the Merchant portal. | |
key | String | Unique identifier of the shipment type. | |
isActive | Boolean | Defines if the shipment type is active. You can only add active shipment types to offers. | |
stores | Object | Defines the stores the shipment type is to be available for. |
Response
Response sample:
{
"data": {
"type": "shipment-types",
"id": "fa575a58-5119-5407-a00b-d1aa01fec63d",
"attributes": {
"name": "Curbside pickup",
"key": "c-pickup",
"isActive": false,
"stores": [
"DE",
"AT"
]
},
"links": {
"self": "https://glue-backend.mysprykershop.com/shipment-types/fa575a58-5119-5407-a00b-d1aa01fec63d"
}
}
}
RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
---|---|---|---|
shipment-types | name | String | You will use it to as a reference when adding shipment types to offers in the Merchant Portal. |
shipment-types | key | String | Unique key of the shipment type. You will use it as a reference when adding shipment types to offers in the Merchant Portal. |
shipment-types | isActive | Boolean | Defines if the shipment type is active. Only active shipment types are displayed in the Merchant Portal. |
shipment-types | stores | Object | Defines the stores this shipment type is available for. |
Possible errors
CODE | REASON |
---|---|
5501 | The shipment type with the specified ID doesn’t exist. |
To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.
Thank you!
For submitting the form