All URIs are relative to https://core.hivelocity.net/api/v2
Method | HTTP request | Description |
---|---|---|
DeleteOrderGroupIdResource | Delete /order-groups/{orderGroupId} | Delete the specified Order Group |
GetOrderGroupIdResource | Get /order-groups/{orderGroupId} | Return an Order Group |
GetOrderGroupResource | Get /order-groups/ | Return a list with all Order Groups |
PostOrderGroupResource | Post /order-groups/ | Create a new Order Group |
PutOrderGroupIdResource | Put /order-groups/{orderGroupId} | Update an Order Group |
DeleteOrderGroupIdResource(ctx, orderGroupId) Delete the specified Order Group
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
orderGroupId | int32 | Id of the order group to interact with |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderGroup GetOrderGroupIdResource(ctx, orderGroupId, optional) Return an Order Group
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
orderGroupId | int32 | Id of the order group to interact with | |
optional | *OrderGroupsApiGetOrderGroupIdResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderGroupsApiGetOrderGroupIdResourceOpts struct
Name | Type | Description | Notes |
---|
xFields | optional.String| An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]OrderGroup GetOrderGroupResource(ctx, optional) Return a list with all Order Groups
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *OrderGroupsApiGetOrderGroupResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderGroupsApiGetOrderGroupResourceOpts struct
Name | Type | Description | Notes |
---|---|---|---|
xFields | optional.String | An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderGroup PostOrderGroupResource(ctx, payload, optional) Create a new Order Group
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
payload | OrderGroupCreate | ||
optional | *OrderGroupsApiPostOrderGroupResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderGroupsApiPostOrderGroupResourceOpts struct
Name | Type | Description | Notes |
---|
xFields | optional.String| An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderGroup PutOrderGroupIdResource(ctx, orderGroupId, payload, optional) Update an Order Group
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
orderGroupId | int32 | Id of the order group to interact with | |
payload | OrderGroupUpdate | ||
optional | *OrderGroupsApiPutOrderGroupIdResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderGroupsApiPutOrderGroupIdResourceOpts struct
Name | Type | Description | Notes |
---|
xFields | optional.String| An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]