POST /apiv2/companyLocations/addPermanentPickupsToCompanyLocation
Servers
- /
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
permanentPickups[] |
Array | No |
Permanent pickups associated with the company location |
permanentPickups[].id |
Integer | No |
The ID of this permanent pickup in MachShip |
permanentPickups[].carrierId |
Integer | No |
A carrier's ID in MachShip |
permanentPickups[].linkType |
Integer | No |
0 = LinkToAllServices, 1 = LinkToSpecificServices Possible values:
|
permanentPickups[].serviceIds[] |
Array | No |
When Machship.Common.Models.ApiV2Models.CompanyLocations.PermanentPickupV2.LinkType is set to Machship.Common.Models.ApiV2Models.CompanyLocations.PermanentPickupLink.LinkToSpecificServices then this is an array of the carrier's service IDs in MachShip |
companyLocationId |
Integer | No |
The ID of an existing company location in MachShip |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.