README
¶
Quiqup Carryio
The Quiqup Carryio API client is a golang client implemented using oapi-codegen.
Example Usages (Authenticated)
In Development
Package is in active development
License
This project is licensed under the MIT License. See the LICENSE file for details.
Changelog
All notable changes are documented in CHANGELOG.md. This project follows Keep a Changelog and Semantic Versioning.
Branching Model
Git flow config should be in .git/config
[gitflow "branch"]
master = main
develop = develop
[gitflow "prefix"]
feature = feat
release = release/
hotfix = hotfix/
support = support/
versiontag = v
We use Gitflow for managing releases and tracking changes in the changelog. Please follow the Gitflow workflow for all contributions and releases.
Documentation
¶
Overview ¶
Package gocarryio provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- Constants
- func NewCancelManifestRequest(server string, manifestId string, params *CancelManifestParams) (*http.Request, error)
- func NewCancelShipmentRequest(server string, shipmentId string, params *CancelShipmentParams, ...) (*http.Request, error)
- func NewCancelShipmentRequestWithBody(server string, shipmentId string, params *CancelShipmentParams, ...) (*http.Request, error)
- func NewConfirmShipmentRequest(server string, shipmentId string, params *ConfirmShipmentParams, ...) (*http.Request, error)
- func NewConfirmShipmentRequestWithBody(server string, shipmentId string, params *ConfirmShipmentParams, ...) (*http.Request, error)
- func NewCreateAttributeRequest(server string, params *CreateAttributeParams, ...) (*http.Request, error)
- func NewCreateAttributeRequestWithBody(server string, params *CreateAttributeParams, contentType string, ...) (*http.Request, error)
- func NewCreateAutomationRulesRequest(server string, automationRulesetId string, params *CreateAutomationRulesParams, ...) (*http.Request, error)
- func NewCreateAutomationRulesRequestWithBody(server string, automationRulesetId string, params *CreateAutomationRulesParams, ...) (*http.Request, error)
- func NewCreateAutomationRulesetAndRulesRequest(server string, params *CreateAutomationRulesetAndRulesParams, ...) (*http.Request, error)
- func NewCreateAutomationRulesetAndRulesRequestWithBody(server string, params *CreateAutomationRulesetAndRulesParams, ...) (*http.Request, error)
- func NewCreateCarrierAccountRequest(server string, params *CreateCarrierAccountParams, ...) (*http.Request, error)
- func NewCreateCarrierAccountRequestWithBody(server string, params *CreateCarrierAccountParams, contentType string, ...) (*http.Request, error)
- func NewCreateManifestRequest(server string, params *CreateManifestParams, ...) (*http.Request, error)
- func NewCreateManifestRequestWithBody(server string, params *CreateManifestParams, contentType string, ...) (*http.Request, error)
- func NewCreateServiceLevelRulesRequest(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewCreateServiceLevelRulesRequestWithBody(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewCreateServiceLevelRulesetAndRulesRequest(server string, params *CreateServiceLevelRulesetAndRulesParams, ...) (*http.Request, error)
- func NewCreateServiceLevelRulesetAndRulesRequestWithBody(server string, params *CreateServiceLevelRulesetAndRulesParams, ...) (*http.Request, error)
- func NewCreateShipmentRequest(server string, params *CreateShipmentParams, ...) (*http.Request, error)
- func NewCreateShipmentRequestWithBody(server string, params *CreateShipmentParams, contentType string, ...) (*http.Request, error)
- func NewDeleteAttributeRequest(server string, attributeId string, params *DeleteAttributeParams) (*http.Request, error)
- func NewDeleteAutomationRuleRequest(server string, rulesetId string, automationRuleId string, ...) (*http.Request, error)
- func NewDeleteAutomationRulesetRequest(server string, automationRulesetId string, ...) (*http.Request, error)
- func NewDeleteCarrierAccountRequest(server string, carrierAccountId string, params *DeleteCarrierAccountParams) (*http.Request, error)
- func NewDeleteManifestRequest(server string, manifestId string, params *DeleteManifestParams) (*http.Request, error)
- func NewDeleteServiceLevelRuleRequest(server string, rulesetId string, serviceLevelRuleId string, ...) (*http.Request, error)
- func NewDeleteServiceLevelRulesetRequest(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewEstimateShippingCostForShipmentRequest(server string, shipmentId string, ...) (*http.Request, error)
- func NewGetAccessTokenRequest(server string, body GetAccessTokenJSONRequestBody) (*http.Request, error)
- func NewGetAccessTokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewGetAttributeRequest(server string, attributeId string, params *GetAttributeParams) (*http.Request, error)
- func NewGetAutomationRuleRequest(server string, rulesetId string, automationRuleId string, ...) (*http.Request, error)
- func NewGetAutomationRulesetRequest(server string, automationRulesetId string, params *GetAutomationRulesetParams) (*http.Request, error)
- func NewGetBulkStatusRequest(server string, params *GetBulkStatusParams) (*http.Request, error)
- func NewGetCarrierAccountRequest(server string, carrierAccountId string, params *GetCarrierAccountParams) (*http.Request, error)
- func NewGetManifestRequest(server string, manifestId string, params *GetManifestParams) (*http.Request, error)
- func NewGetServiceLevelRuleRequest(server string, rulesetId string, serviceLevelRuleId string, ...) (*http.Request, error)
- func NewGetServiceLevelRulesetRequest(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewGetShipmentRequest(server string, shipmentId string, params *GetShipmentParams) (*http.Request, error)
- func NewGetShippingRatesRequest(server string, params *GetShippingRatesParams, ...) (*http.Request, error)
- func NewGetShippingRatesRequestWithBody(server string, params *GetShippingRatesParams, contentType string, ...) (*http.Request, error)
- func NewListAttrbutesRequest(server string, params *ListAttrbutesParams) (*http.Request, error)
- func NewListAutomationRulesRequest(server string, automationRulesetId string, params *ListAutomationRulesParams) (*http.Request, error)
- func NewListAutomationRulesetsRequest(server string, params *ListAutomationRulesetsParams) (*http.Request, error)
- func NewListCarrierAccountsRequest(server string, params *ListCarrierAccountsParams) (*http.Request, error)
- func NewListManifestsRequest(server string, params *ListManifestsParams) (*http.Request, error)
- func NewListServiceLevelRulesRequest(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewListServiceLevelRulesetsRequest(server string, params *ListServiceLevelRulesetsParams) (*http.Request, error)
- func NewListShipmentsRequest(server string, params *ListShipmentsParams) (*http.Request, error)
- func NewPatchAutomationRulesetRequest(server string, automationRulesetId string, ...) (*http.Request, error)
- func NewPatchAutomationRulesetRequestWithBody(server string, automationRulesetId string, ...) (*http.Request, error)
- func NewPatchServiceLevelRulesetRequest(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewPatchServiceLevelRulesetRequestWithBody(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewReadyToShipRequest(server string, shipmentId string, params *ReadyToShipParams, ...) (*http.Request, error)
- func NewReadyToShipRequestWithBody(server string, shipmentId string, params *ReadyToShipParams, ...) (*http.Request, error)
- func NewReassignShipmentRequest(server string, shipmentId string, params *ReassignShipmentParams, ...) (*http.Request, error)
- func NewReassignShipmentRequestWithBody(server string, shipmentId string, params *ReassignShipmentParams, ...) (*http.Request, error)
- func NewRefreshLabelRequest(server string, shipmentId string, params *RefreshLabelParams) (*http.Request, error)
- func NewReprocessShipmentRequest(server string, shipmentId string, params *ReprocessShipmentParams, ...) (*http.Request, error)
- func NewReprocessShipmentRequestWithBody(server string, shipmentId string, params *ReprocessShipmentParams, ...) (*http.Request, error)
- func NewRetryManifestRequest(server string, manifestId string, params *RetryManifestParams) (*http.Request, error)
- func NewShipManifestRequest(server string, manifestId string, params *ShipManifestParams) (*http.Request, error)
- func NewUpdateAttributeRequest(server string, attributeId string, params *UpdateAttributeParams, ...) (*http.Request, error)
- func NewUpdateAttributeRequestWithBody(server string, attributeId string, params *UpdateAttributeParams, ...) (*http.Request, error)
- func NewUpdateAutomationRuleRequest(server string, rulesetId string, automationRuleId string, ...) (*http.Request, error)
- func NewUpdateAutomationRuleRequestWithBody(server string, rulesetId string, automationRuleId string, ...) (*http.Request, error)
- func NewUpdateAutomationRulesSequenceRequest(server string, rulesetId string, params *UpdateAutomationRulesSequenceParams, ...) (*http.Request, error)
- func NewUpdateAutomationRulesSequenceRequestWithBody(server string, rulesetId string, params *UpdateAutomationRulesSequenceParams, ...) (*http.Request, error)
- func NewUpdateAutomationRulesetAndRulesRequest(server string, automationRulesetId string, ...) (*http.Request, error)
- func NewUpdateAutomationRulesetAndRulesRequestWithBody(server string, automationRulesetId string, ...) (*http.Request, error)
- func NewUpdateCarrierAccountRequest(server string, carrierAccountId string, params *UpdateCarrierAccountParams, ...) (*http.Request, error)
- func NewUpdateCarrierAccountRequestWithBody(server string, carrierAccountId string, params *UpdateCarrierAccountParams, ...) (*http.Request, error)
- func NewUpdateCollectionScheduleRequest(server string, shipmentId string, params *UpdateCollectionScheduleParams, ...) (*http.Request, error)
- func NewUpdateCollectionScheduleRequestWithBody(server string, shipmentId string, params *UpdateCollectionScheduleParams, ...) (*http.Request, error)
- func NewUpdateDeliveryPromiseRequest(server string, shipmentId string, params *UpdateDeliveryPromiseParams, ...) (*http.Request, error)
- func NewUpdateDeliveryPromiseRequestWithBody(server string, shipmentId string, params *UpdateDeliveryPromiseParams, ...) (*http.Request, error)
- func NewUpdateDeliveryScheduleRequest(server string, shipmentId string, params *UpdateDeliveryScheduleParams, ...) (*http.Request, error)
- func NewUpdateDeliveryScheduleRequestWithBody(server string, shipmentId string, params *UpdateDeliveryScheduleParams, ...) (*http.Request, error)
- func NewUpdateParcelsRequest(server string, shipmentId string, params *UpdateParcelsParams, ...) (*http.Request, error)
- func NewUpdateParcelsRequestWithBody(server string, shipmentId string, params *UpdateParcelsParams, ...) (*http.Request, error)
- func NewUpdateServiceLevelRuleRequest(server string, rulesetId string, serviceLevelRuleId string, ...) (*http.Request, error)
- func NewUpdateServiceLevelRuleRequestWithBody(server string, rulesetId string, serviceLevelRuleId string, ...) (*http.Request, error)
- func NewUpdateServiceLevelRulesSequenceRequest(server string, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, ...) (*http.Request, error)
- func NewUpdateServiceLevelRulesSequenceRequestWithBody(server string, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, ...) (*http.Request, error)
- func NewUpdateServiceLevelRulesetAndRulesRequest(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewUpdateServiceLevelRulesetAndRulesRequestWithBody(server string, serviceLevelRulesetId string, ...) (*http.Request, error)
- func NewUpdateShipmentPatchRequest(server string, shipmentId string, params *UpdateShipmentPatchParams, ...) (*http.Request, error)
- func NewUpdateShipmentPatchRequestWithBody(server string, shipmentId string, params *UpdateShipmentPatchParams, ...) (*http.Request, error)
- func NewUpdateShipmentRequest(server string, shipmentId string, params *UpdateShipmentParams, ...) (*http.Request, error)
- func NewUpdateShipmentRequestWithBody(server string, shipmentId string, params *UpdateShipmentParams, ...) (*http.Request, error)
- func NewUpdateStatusRequest(server string, shipmentId string, params *UpdateStatusParams, ...) (*http.Request, error)
- func NewUpdateStatusRequestWithBody(server string, shipmentId string, params *UpdateStatusParams, ...) (*http.Request, error)
- type AddressCode
- type AddressCodeType
- type AttributeRequest
- type AttributeRequestAttributeEntityType
- type AttributeRequestAttributeType
- type AttributeResponse
- type AttributeResponseAttributeEntityType
- type AttributeResponseAttributeType
- type AutomationRuleRequest
- type AutomationRuleRequestCarrierChoice
- type AutomationRuleResponse
- type AutomationRuleResponseCarrierChoice
- type AutomationRulesetWithRulesRequest
- type AutomationRulesetWithRulesResponse
- type BreakdownObject
- type BulkShipmentStatusResponse
- type CancelManifestParams
- type CancelManifestResponse
- type CancelShipmentJSONBody
- type CancelShipmentJSONRequestBody
- type CancelShipmentParams
- type CancelShipmentResponse
- type CarrierAccountEndpointObject
- type CarrierAccountEndpointRequest
- type CarrierAccountObject
- type CarrierAccountRequest
- type CarriyoResponseStatus
- type Client
- func (c *Client) CancelManifest(ctx context.Context, manifestId string, params *CancelManifestParams, ...) (*http.Response, error)
- func (c *Client) CancelShipment(ctx context.Context, shipmentId string, params *CancelShipmentParams, ...) (*http.Response, error)
- func (c *Client) CancelShipmentWithBody(ctx context.Context, shipmentId string, params *CancelShipmentParams, ...) (*http.Response, error)
- func (c *Client) ConfirmShipment(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, ...) (*http.Response, error)
- func (c *Client) ConfirmShipmentWithBody(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, ...) (*http.Response, error)
- func (c *Client) CreateAttribute(ctx context.Context, params *CreateAttributeParams, ...) (*http.Response, error)
- func (c *Client) CreateAttributeWithBody(ctx context.Context, params *CreateAttributeParams, contentType string, ...) (*http.Response, error)
- func (c *Client) CreateAutomationRules(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) CreateAutomationRulesWithBody(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) CreateAutomationRulesetAndRules(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, ...) (*http.Response, error)
- func (c *Client) CreateAutomationRulesetAndRulesWithBody(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, ...) (*http.Response, error)
- func (c *Client) CreateCarrierAccount(ctx context.Context, params *CreateCarrierAccountParams, ...) (*http.Response, error)
- func (c *Client) CreateCarrierAccountWithBody(ctx context.Context, params *CreateCarrierAccountParams, contentType string, ...) (*http.Response, error)
- func (c *Client) CreateManifest(ctx context.Context, params *CreateManifestParams, ...) (*http.Response, error)
- func (c *Client) CreateManifestWithBody(ctx context.Context, params *CreateManifestParams, contentType string, ...) (*http.Response, error)
- func (c *Client) CreateServiceLevelRules(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) CreateServiceLevelRulesWithBody(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) CreateServiceLevelRulesetAndRules(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, ...) (*http.Response, error)
- func (c *Client) CreateServiceLevelRulesetAndRulesWithBody(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, ...) (*http.Response, error)
- func (c *Client) CreateShipment(ctx context.Context, params *CreateShipmentParams, ...) (*http.Response, error)
- func (c *Client) CreateShipmentWithBody(ctx context.Context, params *CreateShipmentParams, contentType string, ...) (*http.Response, error)
- func (c *Client) DeleteAttribute(ctx context.Context, attributeId string, params *DeleteAttributeParams, ...) (*http.Response, error)
- func (c *Client) DeleteAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, ...) (*http.Response, error)
- func (c *Client) DeleteAutomationRuleset(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) DeleteCarrierAccount(ctx context.Context, carrierAccountId string, ...) (*http.Response, error)
- func (c *Client) DeleteManifest(ctx context.Context, manifestId string, params *DeleteManifestParams, ...) (*http.Response, error)
- func (c *Client) DeleteServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, ...) (*http.Response, error)
- func (c *Client) DeleteServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) EstimateShippingCostForShipment(ctx context.Context, shipmentId string, ...) (*http.Response, error)
- func (c *Client) GetAccessToken(ctx context.Context, body GetAccessTokenJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) GetAccessTokenWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) GetAttribute(ctx context.Context, attributeId string, params *GetAttributeParams, ...) (*http.Response, error)
- func (c *Client) GetAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, ...) (*http.Response, error)
- func (c *Client) GetAutomationRuleset(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) GetBulkStatus(ctx context.Context, params *GetBulkStatusParams, ...) (*http.Response, error)
- func (c *Client) GetCarrierAccount(ctx context.Context, carrierAccountId string, params *GetCarrierAccountParams, ...) (*http.Response, error)
- func (c *Client) GetManifest(ctx context.Context, manifestId string, params *GetManifestParams, ...) (*http.Response, error)
- func (c *Client) GetServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, ...) (*http.Response, error)
- func (c *Client) GetServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) GetShipment(ctx context.Context, shipmentId string, params *GetShipmentParams, ...) (*http.Response, error)
- func (c *Client) GetShippingRates(ctx context.Context, params *GetShippingRatesParams, ...) (*http.Response, error)
- func (c *Client) GetShippingRatesWithBody(ctx context.Context, params *GetShippingRatesParams, contentType string, ...) (*http.Response, error)
- func (c *Client) ListAttrbutes(ctx context.Context, params *ListAttrbutesParams, ...) (*http.Response, error)
- func (c *Client) ListAutomationRules(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) ListAutomationRulesets(ctx context.Context, params *ListAutomationRulesetsParams, ...) (*http.Response, error)
- func (c *Client) ListCarrierAccounts(ctx context.Context, params *ListCarrierAccountsParams, ...) (*http.Response, error)
- func (c *Client) ListManifests(ctx context.Context, params *ListManifestsParams, ...) (*http.Response, error)
- func (c *Client) ListServiceLevelRules(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) ListServiceLevelRulesets(ctx context.Context, params *ListServiceLevelRulesetsParams, ...) (*http.Response, error)
- func (c *Client) ListShipments(ctx context.Context, params *ListShipmentsParams, ...) (*http.Response, error)
- func (c *Client) PatchAutomationRuleset(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) PatchAutomationRulesetWithBody(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) PatchServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) PatchServiceLevelRulesetWithBody(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) ReadyToShip(ctx context.Context, shipmentId string, params *ReadyToShipParams, ...) (*http.Response, error)
- func (c *Client) ReadyToShipWithBody(ctx context.Context, shipmentId string, params *ReadyToShipParams, ...) (*http.Response, error)
- func (c *Client) ReassignShipment(ctx context.Context, shipmentId string, params *ReassignShipmentParams, ...) (*http.Response, error)
- func (c *Client) ReassignShipmentWithBody(ctx context.Context, shipmentId string, params *ReassignShipmentParams, ...) (*http.Response, error)
- func (c *Client) RefreshLabel(ctx context.Context, shipmentId string, params *RefreshLabelParams, ...) (*http.Response, error)
- func (c *Client) ReprocessShipment(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, ...) (*http.Response, error)
- func (c *Client) ReprocessShipmentWithBody(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, ...) (*http.Response, error)
- func (c *Client) RetryManifest(ctx context.Context, manifestId string, params *RetryManifestParams, ...) (*http.Response, error)
- func (c *Client) ShipManifest(ctx context.Context, manifestId string, params *ShipManifestParams, ...) (*http.Response, error)
- func (c *Client) UpdateAttribute(ctx context.Context, attributeId string, params *UpdateAttributeParams, ...) (*http.Response, error)
- func (c *Client) UpdateAttributeWithBody(ctx context.Context, attributeId string, params *UpdateAttributeParams, ...) (*http.Response, error)
- func (c *Client) UpdateAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, ...) (*http.Response, error)
- func (c *Client) UpdateAutomationRuleWithBody(ctx context.Context, rulesetId string, automationRuleId string, ...) (*http.Response, error)
- func (c *Client) UpdateAutomationRulesSequence(ctx context.Context, rulesetId string, ...) (*http.Response, error)
- func (c *Client) UpdateAutomationRulesSequenceWithBody(ctx context.Context, rulesetId string, ...) (*http.Response, error)
- func (c *Client) UpdateAutomationRulesetAndRules(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) UpdateAutomationRulesetAndRulesWithBody(ctx context.Context, automationRulesetId string, ...) (*http.Response, error)
- func (c *Client) UpdateCarrierAccount(ctx context.Context, carrierAccountId string, ...) (*http.Response, error)
- func (c *Client) UpdateCarrierAccountWithBody(ctx context.Context, carrierAccountId string, ...) (*http.Response, error)
- func (c *Client) UpdateCollectionSchedule(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, ...) (*http.Response, error)
- func (c *Client) UpdateCollectionScheduleWithBody(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, ...) (*http.Response, error)
- func (c *Client) UpdateDeliveryPromise(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, ...) (*http.Response, error)
- func (c *Client) UpdateDeliveryPromiseWithBody(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, ...) (*http.Response, error)
- func (c *Client) UpdateDeliverySchedule(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, ...) (*http.Response, error)
- func (c *Client) UpdateDeliveryScheduleWithBody(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, ...) (*http.Response, error)
- func (c *Client) UpdateParcels(ctx context.Context, shipmentId string, params *UpdateParcelsParams, ...) (*http.Response, error)
- func (c *Client) UpdateParcelsWithBody(ctx context.Context, shipmentId string, params *UpdateParcelsParams, ...) (*http.Response, error)
- func (c *Client) UpdateServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, ...) (*http.Response, error)
- func (c *Client) UpdateServiceLevelRuleWithBody(ctx context.Context, rulesetId string, serviceLevelRuleId string, ...) (*http.Response, error)
- func (c *Client) UpdateServiceLevelRulesSequence(ctx context.Context, rulesetId string, ...) (*http.Response, error)
- func (c *Client) UpdateServiceLevelRulesSequenceWithBody(ctx context.Context, rulesetId string, ...) (*http.Response, error)
- func (c *Client) UpdateServiceLevelRulesetAndRules(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) UpdateServiceLevelRulesetAndRulesWithBody(ctx context.Context, serviceLevelRulesetId string, ...) (*http.Response, error)
- func (c *Client) UpdateShipment(ctx context.Context, shipmentId string, params *UpdateShipmentParams, ...) (*http.Response, error)
- func (c *Client) UpdateShipmentPatch(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, ...) (*http.Response, error)
- func (c *Client) UpdateShipmentPatchWithBody(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, ...) (*http.Response, error)
- func (c *Client) UpdateShipmentWithBody(ctx context.Context, shipmentId string, params *UpdateShipmentParams, ...) (*http.Response, error)
- func (c *Client) UpdateStatus(ctx context.Context, shipmentId string, params *UpdateStatusParams, ...) (*http.Response, error)
- func (c *Client) UpdateStatusWithBody(ctx context.Context, shipmentId string, params *UpdateStatusParams, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) CancelManifestWithResponse(ctx context.Context, manifestId string, params *CancelManifestParams, ...) (*CancelManifestResponse, error)
- func (c *ClientWithResponses) CancelShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams, ...) (*CancelShipmentResponse, error)
- func (c *ClientWithResponses) CancelShipmentWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams, ...) (*CancelShipmentResponse, error)
- func (c *ClientWithResponses) ConfirmShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, ...) (*ConfirmShipmentResponse, error)
- func (c *ClientWithResponses) ConfirmShipmentWithResponse(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, ...) (*ConfirmShipmentResponse, error)
- func (c *ClientWithResponses) CreateAttributeWithBodyWithResponse(ctx context.Context, params *CreateAttributeParams, contentType string, ...) (*CreateAttributeResponse, error)
- func (c *ClientWithResponses) CreateAttributeWithResponse(ctx context.Context, params *CreateAttributeParams, ...) (*CreateAttributeResponse, error)
- func (c *ClientWithResponses) CreateAutomationRulesWithBodyWithResponse(ctx context.Context, automationRulesetId string, ...) (*CreateAutomationRulesResponse, error)
- func (c *ClientWithResponses) CreateAutomationRulesWithResponse(ctx context.Context, automationRulesetId string, ...) (*CreateAutomationRulesResponse, error)
- func (c *ClientWithResponses) CreateAutomationRulesetAndRulesWithBodyWithResponse(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, ...) (*CreateAutomationRulesetAndRulesResponse, error)
- func (c *ClientWithResponses) CreateAutomationRulesetAndRulesWithResponse(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, ...) (*CreateAutomationRulesetAndRulesResponse, error)
- func (c *ClientWithResponses) CreateCarrierAccountWithBodyWithResponse(ctx context.Context, params *CreateCarrierAccountParams, contentType string, ...) (*CreateCarrierAccountResponse, error)
- func (c *ClientWithResponses) CreateCarrierAccountWithResponse(ctx context.Context, params *CreateCarrierAccountParams, ...) (*CreateCarrierAccountResponse, error)
- func (c *ClientWithResponses) CreateManifestWithBodyWithResponse(ctx context.Context, params *CreateManifestParams, contentType string, ...) (*CreateManifestResponse, error)
- func (c *ClientWithResponses) CreateManifestWithResponse(ctx context.Context, params *CreateManifestParams, ...) (*CreateManifestResponse, error)
- func (c *ClientWithResponses) CreateServiceLevelRulesWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*CreateServiceLevelRulesResponse, error)
- func (c *ClientWithResponses) CreateServiceLevelRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*CreateServiceLevelRulesResponse, error)
- func (c *ClientWithResponses) CreateServiceLevelRulesetAndRulesWithBodyWithResponse(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, ...) (*CreateServiceLevelRulesetAndRulesResponse, error)
- func (c *ClientWithResponses) CreateServiceLevelRulesetAndRulesWithResponse(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, ...) (*CreateServiceLevelRulesetAndRulesResponse, error)
- func (c *ClientWithResponses) CreateShipmentWithBodyWithResponse(ctx context.Context, params *CreateShipmentParams, contentType string, ...) (*CreateShipmentResponse, error)
- func (c *ClientWithResponses) CreateShipmentWithResponse(ctx context.Context, params *CreateShipmentParams, ...) (*CreateShipmentResponse, error)
- func (c *ClientWithResponses) DeleteAttributeWithResponse(ctx context.Context, attributeId string, params *DeleteAttributeParams, ...) (*DeleteAttributeResponse, error)
- func (c *ClientWithResponses) DeleteAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, ...) (*DeleteAutomationRuleResponse, error)
- func (c *ClientWithResponses) DeleteAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, ...) (*DeleteAutomationRulesetResponse, error)
- func (c *ClientWithResponses) DeleteCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, ...) (*DeleteCarrierAccountResponse, error)
- func (c *ClientWithResponses) DeleteManifestWithResponse(ctx context.Context, manifestId string, params *DeleteManifestParams, ...) (*DeleteManifestResponse, error)
- func (c *ClientWithResponses) DeleteServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, ...) (*DeleteServiceLevelRuleResponse, error)
- func (c *ClientWithResponses) DeleteServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*DeleteServiceLevelRulesetResponse, error)
- func (c *ClientWithResponses) EstimateShippingCostForShipmentWithResponse(ctx context.Context, shipmentId string, ...) (*EstimateShippingCostForShipmentResponse, error)
- func (c *ClientWithResponses) GetAccessTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*GetAccessTokenResponse, error)
- func (c *ClientWithResponses) GetAccessTokenWithResponse(ctx context.Context, body GetAccessTokenJSONRequestBody, ...) (*GetAccessTokenResponse, error)
- func (c *ClientWithResponses) GetAttributeWithResponse(ctx context.Context, attributeId string, params *GetAttributeParams, ...) (*GetAttributeResponse, error)
- func (c *ClientWithResponses) GetAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, ...) (*GetAutomationRuleResponse, error)
- func (c *ClientWithResponses) GetAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, ...) (*GetAutomationRulesetResponse, error)
- func (c *ClientWithResponses) GetBulkStatusWithResponse(ctx context.Context, params *GetBulkStatusParams, ...) (*GetBulkStatusResponse, error)
- func (c *ClientWithResponses) GetCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, params *GetCarrierAccountParams, ...) (*GetCarrierAccountResponse, error)
- func (c *ClientWithResponses) GetManifestWithResponse(ctx context.Context, manifestId string, params *GetManifestParams, ...) (*GetManifestResponse, error)
- func (c *ClientWithResponses) GetServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, ...) (*GetServiceLevelRuleResponse, error)
- func (c *ClientWithResponses) GetServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*GetServiceLevelRulesetResponse, error)
- func (c *ClientWithResponses) GetShipmentWithResponse(ctx context.Context, shipmentId string, params *GetShipmentParams, ...) (*GetShipmentResponse, error)
- func (c *ClientWithResponses) GetShippingRatesWithBodyWithResponse(ctx context.Context, params *GetShippingRatesParams, contentType string, ...) (*GetShippingRatesResponse, error)
- func (c *ClientWithResponses) GetShippingRatesWithResponse(ctx context.Context, params *GetShippingRatesParams, ...) (*GetShippingRatesResponse, error)
- func (c *ClientWithResponses) ListAttrbutesWithResponse(ctx context.Context, params *ListAttrbutesParams, ...) (*ListAttrbutesResponse, error)
- func (c *ClientWithResponses) ListAutomationRulesWithResponse(ctx context.Context, automationRulesetId string, ...) (*ListAutomationRulesResponse, error)
- func (c *ClientWithResponses) ListAutomationRulesetsWithResponse(ctx context.Context, params *ListAutomationRulesetsParams, ...) (*ListAutomationRulesetsResponse, error)
- func (c *ClientWithResponses) ListCarrierAccountsWithResponse(ctx context.Context, params *ListCarrierAccountsParams, ...) (*ListCarrierAccountsResponse, error)
- func (c *ClientWithResponses) ListManifestsWithResponse(ctx context.Context, params *ListManifestsParams, ...) (*ListManifestsResponse, error)
- func (c *ClientWithResponses) ListServiceLevelRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*ListServiceLevelRulesResponse, error)
- func (c *ClientWithResponses) ListServiceLevelRulesetsWithResponse(ctx context.Context, params *ListServiceLevelRulesetsParams, ...) (*ListServiceLevelRulesetsResponse, error)
- func (c *ClientWithResponses) ListShipmentsWithResponse(ctx context.Context, params *ListShipmentsParams, ...) (*ListShipmentsResponse, error)
- func (c *ClientWithResponses) PatchAutomationRulesetWithBodyWithResponse(ctx context.Context, automationRulesetId string, ...) (*PatchAutomationRulesetResponse, error)
- func (c *ClientWithResponses) PatchAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, ...) (*PatchAutomationRulesetResponse, error)
- func (c *ClientWithResponses) PatchServiceLevelRulesetWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*PatchServiceLevelRulesetResponse, error)
- func (c *ClientWithResponses) PatchServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*PatchServiceLevelRulesetResponse, error)
- func (c *ClientWithResponses) ReadyToShipWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReadyToShipParams, ...) (*ReadyToShipResponse, error)
- func (c *ClientWithResponses) ReadyToShipWithResponse(ctx context.Context, shipmentId string, params *ReadyToShipParams, ...) (*ReadyToShipResponse, error)
- func (c *ClientWithResponses) ReassignShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReassignShipmentParams, ...) (*ReassignShipmentResponse, error)
- func (c *ClientWithResponses) ReassignShipmentWithResponse(ctx context.Context, shipmentId string, params *ReassignShipmentParams, ...) (*ReassignShipmentResponse, error)
- func (c *ClientWithResponses) RefreshLabelWithResponse(ctx context.Context, shipmentId string, params *RefreshLabelParams, ...) (*RefreshLabelResponse, error)
- func (c *ClientWithResponses) ReprocessShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, ...) (*ReprocessShipmentResponse, error)
- func (c *ClientWithResponses) ReprocessShipmentWithResponse(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, ...) (*ReprocessShipmentResponse, error)
- func (c *ClientWithResponses) RetryManifestWithResponse(ctx context.Context, manifestId string, params *RetryManifestParams, ...) (*RetryManifestResponse, error)
- func (c *ClientWithResponses) ShipManifestWithResponse(ctx context.Context, manifestId string, params *ShipManifestParams, ...) (*ShipManifestResponse, error)
- func (c *ClientWithResponses) UpdateAttributeWithBodyWithResponse(ctx context.Context, attributeId string, params *UpdateAttributeParams, ...) (*UpdateAttributeResponse, error)
- func (c *ClientWithResponses) UpdateAttributeWithResponse(ctx context.Context, attributeId string, params *UpdateAttributeParams, ...) (*UpdateAttributeResponse, error)
- func (c *ClientWithResponses) UpdateAutomationRuleWithBodyWithResponse(ctx context.Context, rulesetId string, automationRuleId string, ...) (*UpdateAutomationRuleResponse, error)
- func (c *ClientWithResponses) UpdateAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, ...) (*UpdateAutomationRuleResponse, error)
- func (c *ClientWithResponses) UpdateAutomationRulesSequenceWithBodyWithResponse(ctx context.Context, rulesetId string, ...) (*UpdateAutomationRulesSequenceResponse, error)
- func (c *ClientWithResponses) UpdateAutomationRulesSequenceWithResponse(ctx context.Context, rulesetId string, ...) (*UpdateAutomationRulesSequenceResponse, error)
- func (c *ClientWithResponses) UpdateAutomationRulesetAndRulesWithBodyWithResponse(ctx context.Context, automationRulesetId string, ...) (*UpdateAutomationRulesetAndRulesResponse, error)
- func (c *ClientWithResponses) UpdateAutomationRulesetAndRulesWithResponse(ctx context.Context, automationRulesetId string, ...) (*UpdateAutomationRulesetAndRulesResponse, error)
- func (c *ClientWithResponses) UpdateCarrierAccountWithBodyWithResponse(ctx context.Context, carrierAccountId string, ...) (*UpdateCarrierAccountResponse, error)
- func (c *ClientWithResponses) UpdateCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, ...) (*UpdateCarrierAccountResponse, error)
- func (c *ClientWithResponses) UpdateCollectionScheduleWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, ...) (*UpdateCollectionScheduleResponse, error)
- func (c *ClientWithResponses) UpdateCollectionScheduleWithResponse(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, ...) (*UpdateCollectionScheduleResponse, error)
- func (c *ClientWithResponses) UpdateDeliveryPromiseWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, ...) (*UpdateDeliveryPromiseResponse, error)
- func (c *ClientWithResponses) UpdateDeliveryPromiseWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, ...) (*UpdateDeliveryPromiseResponse, error)
- func (c *ClientWithResponses) UpdateDeliveryScheduleWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, ...) (*UpdateDeliveryScheduleResponse, error)
- func (c *ClientWithResponses) UpdateDeliveryScheduleWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, ...) (*UpdateDeliveryScheduleResponse, error)
- func (c *ClientWithResponses) UpdateParcelsWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateParcelsParams, ...) (*UpdateParcelsResponse, error)
- func (c *ClientWithResponses) UpdateParcelsWithResponse(ctx context.Context, shipmentId string, params *UpdateParcelsParams, ...) (*UpdateParcelsResponse, error)
- func (c *ClientWithResponses) UpdateServiceLevelRuleWithBodyWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, ...) (*UpdateServiceLevelRuleResponse, error)
- func (c *ClientWithResponses) UpdateServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, ...) (*UpdateServiceLevelRuleResponse, error)
- func (c *ClientWithResponses) UpdateServiceLevelRulesSequenceWithBodyWithResponse(ctx context.Context, rulesetId string, ...) (*UpdateServiceLevelRulesSequenceResponse, error)
- func (c *ClientWithResponses) UpdateServiceLevelRulesSequenceWithResponse(ctx context.Context, rulesetId string, ...) (*UpdateServiceLevelRulesSequenceResponse, error)
- func (c *ClientWithResponses) UpdateServiceLevelRulesetAndRulesWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*UpdateServiceLevelRulesetAndRulesResponse, error)
- func (c *ClientWithResponses) UpdateServiceLevelRulesetAndRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, ...) (*UpdateServiceLevelRulesetAndRulesResponse, error)
- func (c *ClientWithResponses) UpdateShipmentPatchWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, ...) (*UpdateShipmentPatchResponse, error)
- func (c *ClientWithResponses) UpdateShipmentPatchWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, ...) (*UpdateShipmentPatchResponse, error)
- func (c *ClientWithResponses) UpdateShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentParams, ...) (*UpdateShipmentResponse, error)
- func (c *ClientWithResponses) UpdateShipmentWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentParams, ...) (*UpdateShipmentResponse, error)
- func (c *ClientWithResponses) UpdateStatusWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateStatusParams, ...) (*UpdateStatusResponse, error)
- func (c *ClientWithResponses) UpdateStatusWithResponse(ctx context.Context, shipmentId string, params *UpdateStatusParams, ...) (*UpdateStatusResponse, error)
- type ClientWithResponsesInterface
- type CollectionObject
- type CollectionRequest
- type ConfirmShipmentJSONRequestBody
- type ConfirmShipmentParams
- type ConfirmShipmentResponse
- type CreateAttributeJSONRequestBody
- type CreateAttributeParams
- type CreateAttributeResponse
- type CreateAutomationRulesJSONRequestBody
- type CreateAutomationRulesParams
- type CreateAutomationRulesResponse
- type CreateAutomationRulesetAndRulesJSONRequestBody
- type CreateAutomationRulesetAndRulesParams
- type CreateAutomationRulesetAndRulesResponse
- type CreateCarrierAccountJSONRequestBody
- type CreateCarrierAccountParams
- type CreateCarrierAccountResponse
- type CreateManifestJSONRequestBody
- type CreateManifestParams
- type CreateManifestResponse
- type CreateServiceLevelRulesJSONRequestBody
- type CreateServiceLevelRulesParams
- type CreateServiceLevelRulesResponse
- type CreateServiceLevelRulesetAndRulesJSONRequestBody
- type CreateServiceLevelRulesetAndRulesParams
- type CreateServiceLevelRulesetAndRulesResponse
- type CreateShipmentErrorResponse
- type CreateShipmentJSONRequestBody
- type CreateShipmentParams
- type CreateShipmentResponse
- type CustomAttributes
- type CustomAttributesConditionField
- type CustomAttributesConditionFieldOperator
- type CustomAttributesConditionFieldValueOperation
- type CustomFields
- type CustomsObject
- type DaysField
- type DeleteAttributeParams
- type DeleteAttributeResponse
- type DeleteAutomationRuleParams
- type DeleteAutomationRuleResponse
- type DeleteAutomationRulesetParams
- type DeleteAutomationRulesetResponse
- type DeleteCarrierAccountParams
- type DeleteCarrierAccountResponse
- type DeleteManifestParams
- type DeleteManifestResponse
- type DeleteServiceLevelRuleParams
- type DeleteServiceLevelRuleResponse
- type DeleteServiceLevelRulesetParams
- type DeleteServiceLevelRulesetResponse
- type DeliveryObject
- type DeliveryRequest
- type Dimension
- type DimensionUnit
- type DocumentObject
- type ErrorDetail
- type EstimateShippingCostForShipmentParams
- type EstimateShippingCostForShipmentResponse
- type EstimatedShippingCost
- type FreeFormRequest
- type FreeFormRequestType
- type GeographyConditionField
- type GeographyConditionFieldOperator
- type GetAccessTokenJSONBody
- type GetAccessTokenJSONRequestBody
- type GetAccessTokenResponse
- type GetAttributeParams
- type GetAttributeResponse
- type GetAutomationRuleParams
- type GetAutomationRuleResponse
- type GetAutomationRulesetParams
- type GetAutomationRulesetResponse
- type GetBulkStatusParams
- type GetBulkStatusResponse
- type GetCarrierAccountParams
- type GetCarrierAccountResponse
- type GetManifestParams
- type GetManifestResponse
- type GetServiceLevelRuleParams
- type GetServiceLevelRuleResponse
- type GetServiceLevelRulesetParams
- type GetServiceLevelRulesetResponse
- type GetShipmentParams
- type GetShipmentResponse
- type GetShippingRatesJSONRequestBody
- type GetShippingRatesParams
- type GetShippingRatesResponse
- type HttpRequestDoer
- type ItemObject
- type ItemObjectWeightUnit
- type ItemRequest
- type ItemRequestBatteryMaterialType
- type ItemRequestBatteryPackingType
- type ItemRequestWeightUnit
- type ListAttrbutesParams
- type ListAttrbutesResponse
- type ListAutomationRulesParams
- type ListAutomationRulesResponse
- type ListAutomationRulesetsParams
- type ListAutomationRulesetsResponse
- type ListCarrierAccountsParams
- type ListCarrierAccountsParamsStatus
- type ListCarrierAccountsResponse
- type ListManifestsParams
- type ListManifestsResponse
- type ListServiceLevelRulesParams
- type ListServiceLevelRulesResponse
- type ListServiceLevelRulesetsParams
- type ListServiceLevelRulesetsResponse
- type ListShipmentsParams
- type ListShipmentsResponse
- type LocationCode
- type LocationCodeType
- type LocationObject
- type LocationObjectType
- type LocationRequest
- type ManifestRequest
- type ManifestResponse
- type NumberAreaConditionField
- type PackageObject
- type ParcelItem
- type ParcelObject
- type ParcelRequest
- type PatchAutomationRulesetJSONRequestBody
- type PatchAutomationRulesetParams
- type PatchAutomationRulesetResponse
- type PatchServiceLevelRulesetJSONRequestBody
- type PatchServiceLevelRulesetParams
- type PatchServiceLevelRulesetResponse
- type PaymentObject
- type PaymentObjectPaymentMode
- type PaymentRequest
- type PaymentRequestPaymentMode
- type PersonalId
- type PostShippingInfo
- type PromisedDeliveryDateRequest
- type ReadyToShipJSONRequestBody
- type ReadyToShipParams
- type ReadyToShipResponse
- type ReassignShipmentJSONBody
- type ReassignShipmentJSONRequestBody
- type ReassignShipmentParams
- type ReassignShipmentResponse
- type ReferencesObject
- type ReferencesRequest
- type RefreshLabelParams
- type RefreshLabelResponse
- type RegistrationNumber
- type RegistrationNumberTypeCode
- type ReprocessShipmentJSONRequestBody
- type ReprocessShipmentParams
- type ReprocessShipmentResponse
- type RequestEditorFn
- type RetryManifestParams
- type RetryManifestResponse
- type RulesetRequest
- type RulesetRequestEntityType
- type RulesetResponse
- type RulesetResponseEntityType
- type SequencesRequest
- type ServiceLevelRuleRequest
- type ServiceLevelRuleRequestConfigType
- type ServiceLevelRuleResponse
- type ServiceLevelRuleResponseConfigType
- type ServiceLevelRulesetWithRulesRequest
- type ServiceLevelRulesetWithRulesResponse
- type ShipManifestParams
- type ShipManifestResponse
- type ShipmentDraftRequest
- type ShipmentDraftRequestEntityType
- type ShipmentDraftRequest_Dropoff
- func (t ShipmentDraftRequest_Dropoff) AsFreeFormRequest() (FreeFormRequest, error)
- func (t ShipmentDraftRequest_Dropoff) AsLocationRequest() (LocationRequest, error)
- func (t *ShipmentDraftRequest_Dropoff) FromFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentDraftRequest_Dropoff) FromLocationRequest(v LocationRequest) error
- func (t ShipmentDraftRequest_Dropoff) MarshalJSON() ([]byte, error)
- func (t *ShipmentDraftRequest_Dropoff) MergeFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentDraftRequest_Dropoff) MergeLocationRequest(v LocationRequest) error
- func (t *ShipmentDraftRequest_Dropoff) UnmarshalJSON(b []byte) error
- type ShipmentDraftRequest_Pickup
- func (t ShipmentDraftRequest_Pickup) AsFreeFormRequest() (FreeFormRequest, error)
- func (t ShipmentDraftRequest_Pickup) AsLocationRequest() (LocationRequest, error)
- func (t *ShipmentDraftRequest_Pickup) FromFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentDraftRequest_Pickup) FromLocationRequest(v LocationRequest) error
- func (t ShipmentDraftRequest_Pickup) MarshalJSON() ([]byte, error)
- func (t *ShipmentDraftRequest_Pickup) MergeFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentDraftRequest_Pickup) MergeLocationRequest(v LocationRequest) error
- func (t *ShipmentDraftRequest_Pickup) UnmarshalJSON(b []byte) error
- type ShipmentObject
- type ShipmentObjectEntityType
- type ShipmentPatchRequest
- type ShipmentPatchRequest_Dropoff
- func (t ShipmentPatchRequest_Dropoff) AsFreeFormRequest() (FreeFormRequest, error)
- func (t ShipmentPatchRequest_Dropoff) AsLocationRequest() (LocationRequest, error)
- func (t *ShipmentPatchRequest_Dropoff) FromFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentPatchRequest_Dropoff) FromLocationRequest(v LocationRequest) error
- func (t ShipmentPatchRequest_Dropoff) MarshalJSON() ([]byte, error)
- func (t *ShipmentPatchRequest_Dropoff) MergeFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentPatchRequest_Dropoff) MergeLocationRequest(v LocationRequest) error
- func (t *ShipmentPatchRequest_Dropoff) UnmarshalJSON(b []byte) error
- type ShipmentPatchRequest_Pickup
- func (t ShipmentPatchRequest_Pickup) AsFreeFormRequest() (FreeFormRequest, error)
- func (t ShipmentPatchRequest_Pickup) AsLocationRequest() (LocationRequest, error)
- func (t *ShipmentPatchRequest_Pickup) FromFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentPatchRequest_Pickup) FromLocationRequest(v LocationRequest) error
- func (t ShipmentPatchRequest_Pickup) MarshalJSON() ([]byte, error)
- func (t *ShipmentPatchRequest_Pickup) MergeFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentPatchRequest_Pickup) MergeLocationRequest(v LocationRequest) error
- func (t *ShipmentPatchRequest_Pickup) UnmarshalJSON(b []byte) error
- type ShipmentRequest
- type ShipmentRequestEntityType
- type ShipmentRequest_Dropoff
- func (t ShipmentRequest_Dropoff) AsFreeFormRequest() (FreeFormRequest, error)
- func (t ShipmentRequest_Dropoff) AsLocationRequest() (LocationRequest, error)
- func (t *ShipmentRequest_Dropoff) FromFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentRequest_Dropoff) FromLocationRequest(v LocationRequest) error
- func (t ShipmentRequest_Dropoff) MarshalJSON() ([]byte, error)
- func (t *ShipmentRequest_Dropoff) MergeFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentRequest_Dropoff) MergeLocationRequest(v LocationRequest) error
- func (t *ShipmentRequest_Dropoff) UnmarshalJSON(b []byte) error
- type ShipmentRequest_Pickup
- func (t ShipmentRequest_Pickup) AsFreeFormRequest() (FreeFormRequest, error)
- func (t ShipmentRequest_Pickup) AsLocationRequest() (LocationRequest, error)
- func (t *ShipmentRequest_Pickup) FromFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentRequest_Pickup) FromLocationRequest(v LocationRequest) error
- func (t ShipmentRequest_Pickup) MarshalJSON() ([]byte, error)
- func (t *ShipmentRequest_Pickup) MergeFreeFormRequest(v FreeFormRequest) error
- func (t *ShipmentRequest_Pickup) MergeLocationRequest(v LocationRequest) error
- func (t *ShipmentRequest_Pickup) UnmarshalJSON(b []byte) error
- type ShippingRate
- type ShippingRateItemRequest
- type ShippingRateItemRequestWeightUnit
- type ShippingRateLocationRequest
- type ShippingRatePackageObject
- type ShippingRateParcelRequest
- type ShippingRatesRequest
- type ShippingRatesRequestEntityType
- type ShippingRatesRequest_Dropoff
- func (t ShippingRatesRequest_Dropoff) AsLocationRequest() (LocationRequest, error)
- func (t ShippingRatesRequest_Dropoff) AsShippingRateLocationRequest() (ShippingRateLocationRequest, error)
- func (t *ShippingRatesRequest_Dropoff) FromLocationRequest(v LocationRequest) error
- func (t *ShippingRatesRequest_Dropoff) FromShippingRateLocationRequest(v ShippingRateLocationRequest) error
- func (t ShippingRatesRequest_Dropoff) MarshalJSON() ([]byte, error)
- func (t *ShippingRatesRequest_Dropoff) MergeLocationRequest(v LocationRequest) error
- func (t *ShippingRatesRequest_Dropoff) MergeShippingRateLocationRequest(v ShippingRateLocationRequest) error
- func (t *ShippingRatesRequest_Dropoff) UnmarshalJSON(b []byte) error
- type ShippingRatesRequest_Pickup
- func (t ShippingRatesRequest_Pickup) AsLocationRequest() (LocationRequest, error)
- func (t ShippingRatesRequest_Pickup) AsShippingRateLocationRequest() (ShippingRateLocationRequest, error)
- func (t *ShippingRatesRequest_Pickup) FromLocationRequest(v LocationRequest) error
- func (t *ShippingRatesRequest_Pickup) FromShippingRateLocationRequest(v ShippingRateLocationRequest) error
- func (t ShippingRatesRequest_Pickup) MarshalJSON() ([]byte, error)
- func (t *ShippingRatesRequest_Pickup) MergeLocationRequest(v LocationRequest) error
- func (t *ShippingRatesRequest_Pickup) MergeShippingRateLocationRequest(v ShippingRateLocationRequest) error
- func (t *ShippingRatesRequest_Pickup) UnmarshalJSON(b []byte) error
- type ShippingRatesResponse
- type StatusField
- type StringConditionField
- type StringConditionFieldOperator
- type UpdateAttributeJSONRequestBody
- type UpdateAttributeParams
- type UpdateAttributeResponse
- type UpdateAutomationRuleJSONRequestBody
- type UpdateAutomationRuleParams
- type UpdateAutomationRuleResponse
- type UpdateAutomationRulesSequenceJSONRequestBody
- type UpdateAutomationRulesSequenceParams
- type UpdateAutomationRulesSequenceResponse
- type UpdateAutomationRulesetAndRulesJSONRequestBody
- type UpdateAutomationRulesetAndRulesParams
- type UpdateAutomationRulesetAndRulesResponse
- type UpdateCarrierAccountJSONRequestBody
- type UpdateCarrierAccountParams
- type UpdateCarrierAccountResponse
- type UpdateCollectionScheduleJSONRequestBody
- type UpdateCollectionScheduleParams
- type UpdateCollectionScheduleResponse
- type UpdateDeliveryPromiseJSONRequestBody
- type UpdateDeliveryPromiseParams
- type UpdateDeliveryPromiseResponse
- type UpdateDeliveryScheduleJSONRequestBody
- type UpdateDeliveryScheduleParams
- type UpdateDeliveryScheduleResponse
- type UpdateParcelsJSONRequestBody
- type UpdateParcelsParams
- type UpdateParcelsRequest
- type UpdateParcelsResponse
- type UpdateServiceLevelRuleJSONRequestBody
- type UpdateServiceLevelRuleParams
- type UpdateServiceLevelRuleResponse
- type UpdateServiceLevelRulesSequenceJSONRequestBody
- type UpdateServiceLevelRulesSequenceParams
- type UpdateServiceLevelRulesSequenceResponse
- type UpdateServiceLevelRulesetAndRulesJSONRequestBody
- type UpdateServiceLevelRulesetAndRulesParams
- type UpdateServiceLevelRulesetAndRulesResponse
- type UpdateShipmentJSONRequestBody
- type UpdateShipmentParams
- type UpdateShipmentPatchJSONRequestBody
- type UpdateShipmentPatchParams
- type UpdateShipmentPatchResponse
- type UpdateShipmentResponse
- type UpdateStatusJSONBody
- type UpdateStatusJSONRequestBody
- type UpdateStatusParams
- type UpdateStatusResponse
- type Weight
- type WeightUnit
Constants ¶
View Source
const ( BearerAuthScopes = "bearerAuth.Scopes" Oauth2Scopes = "oauth2.Scopes" )
Variables ¶
This section is empty.
Functions ¶
func NewCancelManifestRequest ¶
func NewCancelManifestRequest(server string, manifestId string, params *CancelManifestParams) (*http.Request, error)
NewCancelManifestRequest generates requests for CancelManifest
func NewCancelShipmentRequest ¶
func NewCancelShipmentRequest(server string, shipmentId string, params *CancelShipmentParams, body CancelShipmentJSONRequestBody) (*http.Request, error)
NewCancelShipmentRequest calls the generic CancelShipment builder with application/json body
func NewCancelShipmentRequestWithBody ¶
func NewCancelShipmentRequestWithBody(server string, shipmentId string, params *CancelShipmentParams, contentType string, body io.Reader) (*http.Request, error)
NewCancelShipmentRequestWithBody generates requests for CancelShipment with any type of body
func NewConfirmShipmentRequest ¶
func NewConfirmShipmentRequest(server string, shipmentId string, params *ConfirmShipmentParams, body ConfirmShipmentJSONRequestBody) (*http.Request, error)
NewConfirmShipmentRequest calls the generic ConfirmShipment builder with application/json body
func NewConfirmShipmentRequestWithBody ¶
func NewConfirmShipmentRequestWithBody(server string, shipmentId string, params *ConfirmShipmentParams, contentType string, body io.Reader) (*http.Request, error)
NewConfirmShipmentRequestWithBody generates requests for ConfirmShipment with any type of body
func NewCreateAttributeRequest ¶
func NewCreateAttributeRequest(server string, params *CreateAttributeParams, body CreateAttributeJSONRequestBody) (*http.Request, error)
NewCreateAttributeRequest calls the generic CreateAttribute builder with application/json body
func NewCreateAttributeRequestWithBody ¶
func NewCreateAttributeRequestWithBody(server string, params *CreateAttributeParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateAttributeRequestWithBody generates requests for CreateAttribute with any type of body
func NewCreateAutomationRulesRequest ¶
func NewCreateAutomationRulesRequest(server string, automationRulesetId string, params *CreateAutomationRulesParams, body CreateAutomationRulesJSONRequestBody) (*http.Request, error)
NewCreateAutomationRulesRequest calls the generic CreateAutomationRules builder with application/json body
func NewCreateAutomationRulesRequestWithBody ¶
func NewCreateAutomationRulesRequestWithBody(server string, automationRulesetId string, params *CreateAutomationRulesParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateAutomationRulesRequestWithBody generates requests for CreateAutomationRules with any type of body
func NewCreateAutomationRulesetAndRulesRequest ¶
func NewCreateAutomationRulesetAndRulesRequest(server string, params *CreateAutomationRulesetAndRulesParams, body CreateAutomationRulesetAndRulesJSONRequestBody) (*http.Request, error)
NewCreateAutomationRulesetAndRulesRequest calls the generic CreateAutomationRulesetAndRules builder with application/json body
func NewCreateAutomationRulesetAndRulesRequestWithBody ¶
func NewCreateAutomationRulesetAndRulesRequestWithBody(server string, params *CreateAutomationRulesetAndRulesParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateAutomationRulesetAndRulesRequestWithBody generates requests for CreateAutomationRulesetAndRules with any type of body
func NewCreateCarrierAccountRequest ¶
func NewCreateCarrierAccountRequest(server string, params *CreateCarrierAccountParams, body CreateCarrierAccountJSONRequestBody) (*http.Request, error)
NewCreateCarrierAccountRequest calls the generic CreateCarrierAccount builder with application/json body
func NewCreateCarrierAccountRequestWithBody ¶
func NewCreateCarrierAccountRequestWithBody(server string, params *CreateCarrierAccountParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateCarrierAccountRequestWithBody generates requests for CreateCarrierAccount with any type of body
func NewCreateManifestRequest ¶
func NewCreateManifestRequest(server string, params *CreateManifestParams, body CreateManifestJSONRequestBody) (*http.Request, error)
NewCreateManifestRequest calls the generic CreateManifest builder with application/json body
func NewCreateManifestRequestWithBody ¶
func NewCreateManifestRequestWithBody(server string, params *CreateManifestParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateManifestRequestWithBody generates requests for CreateManifest with any type of body
func NewCreateServiceLevelRulesRequest ¶
func NewCreateServiceLevelRulesRequest(server string, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, body CreateServiceLevelRulesJSONRequestBody) (*http.Request, error)
NewCreateServiceLevelRulesRequest calls the generic CreateServiceLevelRules builder with application/json body
func NewCreateServiceLevelRulesRequestWithBody ¶
func NewCreateServiceLevelRulesRequestWithBody(server string, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateServiceLevelRulesRequestWithBody generates requests for CreateServiceLevelRules with any type of body
func NewCreateServiceLevelRulesetAndRulesRequest ¶
func NewCreateServiceLevelRulesetAndRulesRequest(server string, params *CreateServiceLevelRulesetAndRulesParams, body CreateServiceLevelRulesetAndRulesJSONRequestBody) (*http.Request, error)
NewCreateServiceLevelRulesetAndRulesRequest calls the generic CreateServiceLevelRulesetAndRules builder with application/json body
func NewCreateServiceLevelRulesetAndRulesRequestWithBody ¶
func NewCreateServiceLevelRulesetAndRulesRequestWithBody(server string, params *CreateServiceLevelRulesetAndRulesParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateServiceLevelRulesetAndRulesRequestWithBody generates requests for CreateServiceLevelRulesetAndRules with any type of body
func NewCreateShipmentRequest ¶
func NewCreateShipmentRequest(server string, params *CreateShipmentParams, body CreateShipmentJSONRequestBody) (*http.Request, error)
NewCreateShipmentRequest calls the generic CreateShipment builder with application/json body
func NewCreateShipmentRequestWithBody ¶
func NewCreateShipmentRequestWithBody(server string, params *CreateShipmentParams, contentType string, body io.Reader) (*http.Request, error)
NewCreateShipmentRequestWithBody generates requests for CreateShipment with any type of body
func NewDeleteAttributeRequest ¶
func NewDeleteAttributeRequest(server string, attributeId string, params *DeleteAttributeParams) (*http.Request, error)
NewDeleteAttributeRequest generates requests for DeleteAttribute
func NewDeleteAutomationRuleRequest ¶
func NewDeleteAutomationRuleRequest(server string, rulesetId string, automationRuleId string, params *DeleteAutomationRuleParams) (*http.Request, error)
NewDeleteAutomationRuleRequest generates requests for DeleteAutomationRule
func NewDeleteAutomationRulesetRequest ¶
func NewDeleteAutomationRulesetRequest(server string, automationRulesetId string, params *DeleteAutomationRulesetParams) (*http.Request, error)
NewDeleteAutomationRulesetRequest generates requests for DeleteAutomationRuleset
func NewDeleteCarrierAccountRequest ¶
func NewDeleteCarrierAccountRequest(server string, carrierAccountId string, params *DeleteCarrierAccountParams) (*http.Request, error)
NewDeleteCarrierAccountRequest generates requests for DeleteCarrierAccount
func NewDeleteManifestRequest ¶
func NewDeleteManifestRequest(server string, manifestId string, params *DeleteManifestParams) (*http.Request, error)
NewDeleteManifestRequest generates requests for DeleteManifest
func NewDeleteServiceLevelRuleRequest ¶
func NewDeleteServiceLevelRuleRequest(server string, rulesetId string, serviceLevelRuleId string, params *DeleteServiceLevelRuleParams) (*http.Request, error)
NewDeleteServiceLevelRuleRequest generates requests for DeleteServiceLevelRule
func NewDeleteServiceLevelRulesetRequest ¶
func NewDeleteServiceLevelRulesetRequest(server string, serviceLevelRulesetId string, params *DeleteServiceLevelRulesetParams) (*http.Request, error)
NewDeleteServiceLevelRulesetRequest generates requests for DeleteServiceLevelRuleset
func NewEstimateShippingCostForShipmentRequest ¶
func NewEstimateShippingCostForShipmentRequest(server string, shipmentId string, params *EstimateShippingCostForShipmentParams) (*http.Request, error)
NewEstimateShippingCostForShipmentRequest generates requests for EstimateShippingCostForShipment
func NewGetAccessTokenRequest ¶ added in v0.3.0
func NewGetAccessTokenRequest(server string, body GetAccessTokenJSONRequestBody) (*http.Request, error)
NewGetAccessTokenRequest calls the generic GetAccessToken builder with application/json body
func NewGetAccessTokenRequestWithBody ¶ added in v0.3.0
func NewGetAccessTokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewGetAccessTokenRequestWithBody generates requests for GetAccessToken with any type of body
func NewGetAttributeRequest ¶
func NewGetAttributeRequest(server string, attributeId string, params *GetAttributeParams) (*http.Request, error)
NewGetAttributeRequest generates requests for GetAttribute
func NewGetAutomationRuleRequest ¶
func NewGetAutomationRuleRequest(server string, rulesetId string, automationRuleId string, params *GetAutomationRuleParams) (*http.Request, error)
NewGetAutomationRuleRequest generates requests for GetAutomationRule
func NewGetAutomationRulesetRequest ¶
func NewGetAutomationRulesetRequest(server string, automationRulesetId string, params *GetAutomationRulesetParams) (*http.Request, error)
NewGetAutomationRulesetRequest generates requests for GetAutomationRuleset
func NewGetBulkStatusRequest ¶
func NewGetBulkStatusRequest(server string, params *GetBulkStatusParams) (*http.Request, error)
NewGetBulkStatusRequest generates requests for GetBulkStatus
func NewGetCarrierAccountRequest ¶
func NewGetCarrierAccountRequest(server string, carrierAccountId string, params *GetCarrierAccountParams) (*http.Request, error)
NewGetCarrierAccountRequest generates requests for GetCarrierAccount
func NewGetManifestRequest ¶
func NewGetManifestRequest(server string, manifestId string, params *GetManifestParams) (*http.Request, error)
NewGetManifestRequest generates requests for GetManifest
func NewGetServiceLevelRuleRequest ¶
func NewGetServiceLevelRuleRequest(server string, rulesetId string, serviceLevelRuleId string, params *GetServiceLevelRuleParams) (*http.Request, error)
NewGetServiceLevelRuleRequest generates requests for GetServiceLevelRule
func NewGetServiceLevelRulesetRequest ¶
func NewGetServiceLevelRulesetRequest(server string, serviceLevelRulesetId string, params *GetServiceLevelRulesetParams) (*http.Request, error)
NewGetServiceLevelRulesetRequest generates requests for GetServiceLevelRuleset
func NewGetShipmentRequest ¶
func NewGetShipmentRequest(server string, shipmentId string, params *GetShipmentParams) (*http.Request, error)
NewGetShipmentRequest generates requests for GetShipment
func NewGetShippingRatesRequest ¶
func NewGetShippingRatesRequest(server string, params *GetShippingRatesParams, body GetShippingRatesJSONRequestBody) (*http.Request, error)
NewGetShippingRatesRequest calls the generic GetShippingRates builder with application/json body
func NewGetShippingRatesRequestWithBody ¶
func NewGetShippingRatesRequestWithBody(server string, params *GetShippingRatesParams, contentType string, body io.Reader) (*http.Request, error)
NewGetShippingRatesRequestWithBody generates requests for GetShippingRates with any type of body
func NewListAttrbutesRequest ¶
func NewListAttrbutesRequest(server string, params *ListAttrbutesParams) (*http.Request, error)
NewListAttrbutesRequest generates requests for ListAttrbutes
func NewListAutomationRulesRequest ¶
func NewListAutomationRulesRequest(server string, automationRulesetId string, params *ListAutomationRulesParams) (*http.Request, error)
NewListAutomationRulesRequest generates requests for ListAutomationRules
func NewListAutomationRulesetsRequest ¶
func NewListAutomationRulesetsRequest(server string, params *ListAutomationRulesetsParams) (*http.Request, error)
NewListAutomationRulesetsRequest generates requests for ListAutomationRulesets
func NewListCarrierAccountsRequest ¶
func NewListCarrierAccountsRequest(server string, params *ListCarrierAccountsParams) (*http.Request, error)
NewListCarrierAccountsRequest generates requests for ListCarrierAccounts
func NewListManifestsRequest ¶
func NewListManifestsRequest(server string, params *ListManifestsParams) (*http.Request, error)
NewListManifestsRequest generates requests for ListManifests
func NewListServiceLevelRulesRequest ¶
func NewListServiceLevelRulesRequest(server string, serviceLevelRulesetId string, params *ListServiceLevelRulesParams) (*http.Request, error)
NewListServiceLevelRulesRequest generates requests for ListServiceLevelRules
func NewListServiceLevelRulesetsRequest ¶
func NewListServiceLevelRulesetsRequest(server string, params *ListServiceLevelRulesetsParams) (*http.Request, error)
NewListServiceLevelRulesetsRequest generates requests for ListServiceLevelRulesets
func NewListShipmentsRequest ¶
func NewListShipmentsRequest(server string, params *ListShipmentsParams) (*http.Request, error)
NewListShipmentsRequest generates requests for ListShipments
func NewPatchAutomationRulesetRequest ¶
func NewPatchAutomationRulesetRequest(server string, automationRulesetId string, params *PatchAutomationRulesetParams, body PatchAutomationRulesetJSONRequestBody) (*http.Request, error)
NewPatchAutomationRulesetRequest calls the generic PatchAutomationRuleset builder with application/json body
func NewPatchAutomationRulesetRequestWithBody ¶
func NewPatchAutomationRulesetRequestWithBody(server string, automationRulesetId string, params *PatchAutomationRulesetParams, contentType string, body io.Reader) (*http.Request, error)
NewPatchAutomationRulesetRequestWithBody generates requests for PatchAutomationRuleset with any type of body
func NewPatchServiceLevelRulesetRequest ¶
func NewPatchServiceLevelRulesetRequest(server string, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, body PatchServiceLevelRulesetJSONRequestBody) (*http.Request, error)
NewPatchServiceLevelRulesetRequest calls the generic PatchServiceLevelRuleset builder with application/json body
func NewPatchServiceLevelRulesetRequestWithBody ¶
func NewPatchServiceLevelRulesetRequestWithBody(server string, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, contentType string, body io.Reader) (*http.Request, error)
NewPatchServiceLevelRulesetRequestWithBody generates requests for PatchServiceLevelRuleset with any type of body
func NewReadyToShipRequest ¶
func NewReadyToShipRequest(server string, shipmentId string, params *ReadyToShipParams, body ReadyToShipJSONRequestBody) (*http.Request, error)
NewReadyToShipRequest calls the generic ReadyToShip builder with application/json body
func NewReadyToShipRequestWithBody ¶
func NewReadyToShipRequestWithBody(server string, shipmentId string, params *ReadyToShipParams, contentType string, body io.Reader) (*http.Request, error)
NewReadyToShipRequestWithBody generates requests for ReadyToShip with any type of body
func NewReassignShipmentRequest ¶
func NewReassignShipmentRequest(server string, shipmentId string, params *ReassignShipmentParams, body ReassignShipmentJSONRequestBody) (*http.Request, error)
NewReassignShipmentRequest calls the generic ReassignShipment builder with application/json body
func NewReassignShipmentRequestWithBody ¶
func NewReassignShipmentRequestWithBody(server string, shipmentId string, params *ReassignShipmentParams, contentType string, body io.Reader) (*http.Request, error)
NewReassignShipmentRequestWithBody generates requests for ReassignShipment with any type of body
func NewRefreshLabelRequest ¶
func NewRefreshLabelRequest(server string, shipmentId string, params *RefreshLabelParams) (*http.Request, error)
NewRefreshLabelRequest generates requests for RefreshLabel
func NewReprocessShipmentRequest ¶
func NewReprocessShipmentRequest(server string, shipmentId string, params *ReprocessShipmentParams, body ReprocessShipmentJSONRequestBody) (*http.Request, error)
NewReprocessShipmentRequest calls the generic ReprocessShipment builder with application/json body
func NewReprocessShipmentRequestWithBody ¶
func NewReprocessShipmentRequestWithBody(server string, shipmentId string, params *ReprocessShipmentParams, contentType string, body io.Reader) (*http.Request, error)
NewReprocessShipmentRequestWithBody generates requests for ReprocessShipment with any type of body
func NewRetryManifestRequest ¶
func NewRetryManifestRequest(server string, manifestId string, params *RetryManifestParams) (*http.Request, error)
NewRetryManifestRequest generates requests for RetryManifest
func NewShipManifestRequest ¶
func NewShipManifestRequest(server string, manifestId string, params *ShipManifestParams) (*http.Request, error)
NewShipManifestRequest generates requests for ShipManifest
func NewUpdateAttributeRequest ¶
func NewUpdateAttributeRequest(server string, attributeId string, params *UpdateAttributeParams, body UpdateAttributeJSONRequestBody) (*http.Request, error)
NewUpdateAttributeRequest calls the generic UpdateAttribute builder with application/json body
func NewUpdateAttributeRequestWithBody ¶
func NewUpdateAttributeRequestWithBody(server string, attributeId string, params *UpdateAttributeParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateAttributeRequestWithBody generates requests for UpdateAttribute with any type of body
func NewUpdateAutomationRuleRequest ¶
func NewUpdateAutomationRuleRequest(server string, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, body UpdateAutomationRuleJSONRequestBody) (*http.Request, error)
NewUpdateAutomationRuleRequest calls the generic UpdateAutomationRule builder with application/json body
func NewUpdateAutomationRuleRequestWithBody ¶
func NewUpdateAutomationRuleRequestWithBody(server string, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateAutomationRuleRequestWithBody generates requests for UpdateAutomationRule with any type of body
func NewUpdateAutomationRulesSequenceRequest ¶
func NewUpdateAutomationRulesSequenceRequest(server string, rulesetId string, params *UpdateAutomationRulesSequenceParams, body UpdateAutomationRulesSequenceJSONRequestBody) (*http.Request, error)
NewUpdateAutomationRulesSequenceRequest calls the generic UpdateAutomationRulesSequence builder with application/json body
func NewUpdateAutomationRulesSequenceRequestWithBody ¶
func NewUpdateAutomationRulesSequenceRequestWithBody(server string, rulesetId string, params *UpdateAutomationRulesSequenceParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateAutomationRulesSequenceRequestWithBody generates requests for UpdateAutomationRulesSequence with any type of body
func NewUpdateAutomationRulesetAndRulesRequest ¶
func NewUpdateAutomationRulesetAndRulesRequest(server string, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, body UpdateAutomationRulesetAndRulesJSONRequestBody) (*http.Request, error)
NewUpdateAutomationRulesetAndRulesRequest calls the generic UpdateAutomationRulesetAndRules builder with application/json body
func NewUpdateAutomationRulesetAndRulesRequestWithBody ¶
func NewUpdateAutomationRulesetAndRulesRequestWithBody(server string, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateAutomationRulesetAndRulesRequestWithBody generates requests for UpdateAutomationRulesetAndRules with any type of body
func NewUpdateCarrierAccountRequest ¶
func NewUpdateCarrierAccountRequest(server string, carrierAccountId string, params *UpdateCarrierAccountParams, body UpdateCarrierAccountJSONRequestBody) (*http.Request, error)
NewUpdateCarrierAccountRequest calls the generic UpdateCarrierAccount builder with application/json body
func NewUpdateCarrierAccountRequestWithBody ¶
func NewUpdateCarrierAccountRequestWithBody(server string, carrierAccountId string, params *UpdateCarrierAccountParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateCarrierAccountRequestWithBody generates requests for UpdateCarrierAccount with any type of body
func NewUpdateCollectionScheduleRequest ¶
func NewUpdateCollectionScheduleRequest(server string, shipmentId string, params *UpdateCollectionScheduleParams, body UpdateCollectionScheduleJSONRequestBody) (*http.Request, error)
NewUpdateCollectionScheduleRequest calls the generic UpdateCollectionSchedule builder with application/json body
func NewUpdateCollectionScheduleRequestWithBody ¶
func NewUpdateCollectionScheduleRequestWithBody(server string, shipmentId string, params *UpdateCollectionScheduleParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateCollectionScheduleRequestWithBody generates requests for UpdateCollectionSchedule with any type of body
func NewUpdateDeliveryPromiseRequest ¶
func NewUpdateDeliveryPromiseRequest(server string, shipmentId string, params *UpdateDeliveryPromiseParams, body UpdateDeliveryPromiseJSONRequestBody) (*http.Request, error)
NewUpdateDeliveryPromiseRequest calls the generic UpdateDeliveryPromise builder with application/json body
func NewUpdateDeliveryPromiseRequestWithBody ¶
func NewUpdateDeliveryPromiseRequestWithBody(server string, shipmentId string, params *UpdateDeliveryPromiseParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateDeliveryPromiseRequestWithBody generates requests for UpdateDeliveryPromise with any type of body
func NewUpdateDeliveryScheduleRequest ¶
func NewUpdateDeliveryScheduleRequest(server string, shipmentId string, params *UpdateDeliveryScheduleParams, body UpdateDeliveryScheduleJSONRequestBody) (*http.Request, error)
NewUpdateDeliveryScheduleRequest calls the generic UpdateDeliverySchedule builder with application/json body
func NewUpdateDeliveryScheduleRequestWithBody ¶
func NewUpdateDeliveryScheduleRequestWithBody(server string, shipmentId string, params *UpdateDeliveryScheduleParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateDeliveryScheduleRequestWithBody generates requests for UpdateDeliverySchedule with any type of body
func NewUpdateParcelsRequest ¶
func NewUpdateParcelsRequest(server string, shipmentId string, params *UpdateParcelsParams, body UpdateParcelsJSONRequestBody) (*http.Request, error)
NewUpdateParcelsRequest calls the generic UpdateParcels builder with application/json body
func NewUpdateParcelsRequestWithBody ¶
func NewUpdateParcelsRequestWithBody(server string, shipmentId string, params *UpdateParcelsParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateParcelsRequestWithBody generates requests for UpdateParcels with any type of body
func NewUpdateServiceLevelRuleRequest ¶
func NewUpdateServiceLevelRuleRequest(server string, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, body UpdateServiceLevelRuleJSONRequestBody) (*http.Request, error)
NewUpdateServiceLevelRuleRequest calls the generic UpdateServiceLevelRule builder with application/json body
func NewUpdateServiceLevelRuleRequestWithBody ¶
func NewUpdateServiceLevelRuleRequestWithBody(server string, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateServiceLevelRuleRequestWithBody generates requests for UpdateServiceLevelRule with any type of body
func NewUpdateServiceLevelRulesSequenceRequest ¶
func NewUpdateServiceLevelRulesSequenceRequest(server string, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, body UpdateServiceLevelRulesSequenceJSONRequestBody) (*http.Request, error)
NewUpdateServiceLevelRulesSequenceRequest calls the generic UpdateServiceLevelRulesSequence builder with application/json body
func NewUpdateServiceLevelRulesSequenceRequestWithBody ¶
func NewUpdateServiceLevelRulesSequenceRequestWithBody(server string, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateServiceLevelRulesSequenceRequestWithBody generates requests for UpdateServiceLevelRulesSequence with any type of body
func NewUpdateServiceLevelRulesetAndRulesRequest ¶
func NewUpdateServiceLevelRulesetAndRulesRequest(server string, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, body UpdateServiceLevelRulesetAndRulesJSONRequestBody) (*http.Request, error)
NewUpdateServiceLevelRulesetAndRulesRequest calls the generic UpdateServiceLevelRulesetAndRules builder with application/json body
func NewUpdateServiceLevelRulesetAndRulesRequestWithBody ¶
func NewUpdateServiceLevelRulesetAndRulesRequestWithBody(server string, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateServiceLevelRulesetAndRulesRequestWithBody generates requests for UpdateServiceLevelRulesetAndRules with any type of body
func NewUpdateShipmentPatchRequest ¶
func NewUpdateShipmentPatchRequest(server string, shipmentId string, params *UpdateShipmentPatchParams, body UpdateShipmentPatchJSONRequestBody) (*http.Request, error)
NewUpdateShipmentPatchRequest calls the generic UpdateShipmentPatch builder with application/json body
func NewUpdateShipmentPatchRequestWithBody ¶
func NewUpdateShipmentPatchRequestWithBody(server string, shipmentId string, params *UpdateShipmentPatchParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateShipmentPatchRequestWithBody generates requests for UpdateShipmentPatch with any type of body
func NewUpdateShipmentRequest ¶
func NewUpdateShipmentRequest(server string, shipmentId string, params *UpdateShipmentParams, body UpdateShipmentJSONRequestBody) (*http.Request, error)
NewUpdateShipmentRequest calls the generic UpdateShipment builder with application/json body
func NewUpdateShipmentRequestWithBody ¶
func NewUpdateShipmentRequestWithBody(server string, shipmentId string, params *UpdateShipmentParams, contentType string, body io.Reader) (*http.Request, error)
NewUpdateShipmentRequestWithBody generates requests for UpdateShipment with any type of body
func NewUpdateStatusRequest ¶
func NewUpdateStatusRequest(server string, shipmentId string, params *UpdateStatusParams, body UpdateStatusJSONRequestBody) (*http.Request, error)
NewUpdateStatusRequest calls the generic UpdateStatus builder with application/json body
Types ¶
type AddressCode ¶ added in v0.4.2
type AddressCode struct {
// Type Type of location code
Type AddressCodeType `json:"type"`
// Value The location code value
Value string `json:"value"`
}
AddressCode Location code identifier for the address
type AddressCodeType ¶ added in v0.4.2
type AddressCodeType string
AddressCodeType Type of location code
const ( EMIRATESMAKANICODE AddressCodeType = "EMIRATES_MAKANI_CODE" KUWAITPACICODE AddressCodeType = "KUWAIT_PACI_CODE" SAUDISHORTCODE AddressCodeType = "SAUDI_SHORT_CODE" WHAT3WORDS AddressCodeType = "WHAT_3_WORDS" )
Defines values for AddressCodeType.
type AttributeRequest ¶
type AttributeRequest struct {
AllowedValues []string `json:"allowed_values"`
AttributeEntityType *AttributeRequestAttributeEntityType `json:"attribute_entity_type,omitempty"`
AttributeName string `json:"attribute_name"`
AttributeType AttributeRequestAttributeType `json:"attribute_type"`
Merchants *[]string `json:"merchants,omitempty"`
}
AttributeRequest defines model for attribute-request.
type AttributeRequestAttributeEntityType ¶
type AttributeRequestAttributeEntityType string
AttributeRequestAttributeEntityType defines model for AttributeRequest.AttributeEntityType.
const ( AttributeRequestAttributeEntityTypeADDRESS AttributeRequestAttributeEntityType = "ADDRESS" AttributeRequestAttributeEntityTypePRODUCT AttributeRequestAttributeEntityType = "PRODUCT" AttributeRequestAttributeEntityTypeSHIPMENT AttributeRequestAttributeEntityType = "SHIPMENT" )
Defines values for AttributeRequestAttributeEntityType.
type AttributeRequestAttributeType ¶
type AttributeRequestAttributeType string
AttributeRequestAttributeType defines model for AttributeRequest.AttributeType.
const ( AttributeRequestAttributeTypeBOOLEAN AttributeRequestAttributeType = "BOOLEAN" AttributeRequestAttributeTypeENUM AttributeRequestAttributeType = "ENUM" AttributeRequestAttributeTypeMAP AttributeRequestAttributeType = "MAP" AttributeRequestAttributeTypeNUMBER AttributeRequestAttributeType = "NUMBER" AttributeRequestAttributeTypeSTRING AttributeRequestAttributeType = "STRING" )
Defines values for AttributeRequestAttributeType.
type AttributeResponse ¶
type AttributeResponse struct {
AllowedValues []string `json:"allowed_values"`
AttributeEntityType *AttributeResponseAttributeEntityType `json:"attribute_entity_type,omitempty"`
AttributeName string `json:"attribute_name"`
AttributeType AttributeResponseAttributeType `json:"attribute_type"`
CustomAttributeId *string `json:"custom_attribute_id,omitempty"`
Merchants *[]string `json:"merchants,omitempty"`
}
AttributeResponse defines model for attribute-response.
type AttributeResponseAttributeEntityType ¶
type AttributeResponseAttributeEntityType string
AttributeResponseAttributeEntityType defines model for AttributeResponse.AttributeEntityType.
const ( AttributeResponseAttributeEntityTypeADDRESS AttributeResponseAttributeEntityType = "ADDRESS" AttributeResponseAttributeEntityTypePRODUCT AttributeResponseAttributeEntityType = "PRODUCT" AttributeResponseAttributeEntityTypeSHIPMENT AttributeResponseAttributeEntityType = "SHIPMENT" )
Defines values for AttributeResponseAttributeEntityType.
type AttributeResponseAttributeType ¶
type AttributeResponseAttributeType string
AttributeResponseAttributeType defines model for AttributeResponse.AttributeType.
const ( AttributeResponseAttributeTypeBOOLEAN AttributeResponseAttributeType = "BOOLEAN" AttributeResponseAttributeTypeENUM AttributeResponseAttributeType = "ENUM" AttributeResponseAttributeTypeMAP AttributeResponseAttributeType = "MAP" AttributeResponseAttributeTypeNUMBER AttributeResponseAttributeType = "NUMBER" AttributeResponseAttributeTypeSTRING AttributeResponseAttributeType = "STRING" )
Defines values for AttributeResponseAttributeType.
type AutomationRuleRequest ¶
type AutomationRuleRequest struct {
// CarrierAccounts Carrier accounts result
CarrierAccounts []struct {
CarrierAccountId *string `json:"carrier_account_id,omitempty"`
} `json:"carrier_accounts"`
// CarrierChoice Mandatory if 'carrier_accounts' contains more than 1 entry. Used to select the best carrier
CarrierChoice *AutomationRuleRequestCarrierChoice `json:"carrier_choice,omitempty"`
// ChargeableWeight shipment.parcels chargeable (gross or volumetric which higher) weight is inside range
ChargeableWeight *NumberAreaConditionField `json:"chargeable_weight,omitempty"`
// CustomConditions shipment.custom_attributes matches condition
CustomConditions *CustomAttributesConditionField `json:"custom_conditions,omitempty"`
// CustomerAddressVerified Customer is verified or not
CustomerAddressVerified *bool `json:"customer_address_verified,omitempty"`
// DangerousGoods shipment.[items].dangerous_goods is any item matches
DangerousGoods *bool `json:"dangerous_goods,omitempty"`
// Days Days when rule applies
Days *DaysField `json:"days,omitempty"`
// DeliveryType shipment.delivery.delivery_type matches condition
DeliveryType *StringConditionField `json:"delivery_type,omitempty"`
Description *string `json:"description,omitempty"`
// DropoffPartnerLocationIds shipment.dropoff.partner_location_id matches condition
DropoffPartnerLocationIds *StringConditionField `json:"dropoff_partner_location_ids,omitempty"`
// DropoffV2 shipment.dropoff country state city area condition
DropoffV2 *GeographyConditionField `json:"dropoff_v2,omitempty"`
// EndTime Time range when rule applies
EndTime *float32 `json:"end_time,omitempty"`
// GrossWeight shipment.parcels gross weight is inside range
GrossWeight *NumberAreaConditionField `json:"gross_weight,omitempty"`
// Merchant shipment.merchant matches condition
Merchant *StringConditionField `json:"merchant,omitempty"`
// OrderType shipment.order_type matches condition
OrderType *StringConditionField `json:"order_type,omitempty"`
// OrderValueMax shipment.payment.total_amount not more. Use -1 value for infinite
OrderValueMax float32 `json:"order_value_max"`
// OrderValueMin shipment.payment.total_amount not less. Use -1 value for infinite
OrderValueMin float32 `json:"order_value_min"`
// ParcelCount shipment.parcels items count is inside range
ParcelCount *NumberAreaConditionField `json:"parcel_count,omitempty"`
// PaymentType shipment.payment.payment_type matches condition
PaymentType *StringConditionField `json:"payment_type,omitempty"`
// PickupPartnerLocationIds shipment.pickup.partner_location_id matches condition
PickupPartnerLocationIds *StringConditionField `json:"pickup_partner_location_ids,omitempty"`
// PickupV2 shipment.pickup country state city area condition
PickupV2 *GeographyConditionField `json:"pickup_v2,omitempty"`
RuleName string `json:"rule_name"`
// Sequence Sequence number used for rules prioritisation (lower is more important)
Sequence float32 `json:"sequence"`
// SourceType shipment.source.source_type matches condition
SourceType *StringConditionField `json:"source_type,omitempty"`
// StartTime Time range when rule applies
StartTime *float32 `json:"start_time,omitempty"`
Status StatusField `json:"status"`
// VolumetricWeight shipment.parcels volumetric weight is inside range
VolumetricWeight *NumberAreaConditionField `json:"volumetric_weight,omitempty"`
}
AutomationRuleRequest defines model for automation-rule-request.
type AutomationRuleRequestCarrierChoice ¶
type AutomationRuleRequestCarrierChoice string
AutomationRuleRequestCarrierChoice Mandatory if 'carrier_accounts' contains more than 1 entry. Used to select the best carrier
const (
AutomationRuleRequestCarrierChoiceCHEAPESTCARRIER AutomationRuleRequestCarrierChoice = "CHEAPEST_CARRIER"
)
Defines values for AutomationRuleRequestCarrierChoice.
type AutomationRuleResponse ¶
type AutomationRuleResponse struct {
CarrierAccounts *[]struct {
CarrierAccountId *string `json:"carrier_account_id,omitempty"`
} `json:"carrier_accounts,omitempty"`
CarrierChoice *AutomationRuleResponseCarrierChoice `json:"carrier_choice,omitempty"`
ChargeableWeight *NumberAreaConditionField `json:"chargeable_weight,omitempty"`
CreationDate *time.Time `json:"creation_date,omitempty"`
CustomConditions *CustomAttributesConditionField `json:"custom_conditions,omitempty"`
CustomerAddressVerified *bool `json:"customer_address_verified,omitempty"`
DangerousGoods *bool `json:"dangerous_goods,omitempty"`
Days *DaysField `json:"days,omitempty"`
DeliveryType *StringConditionField `json:"delivery_type,omitempty"`
Description *string `json:"description,omitempty"`
DropoffPartnerLocationIds *StringConditionField `json:"dropoff_partner_location_ids,omitempty"`
DropoffV2 *GeographyConditionField `json:"dropoff_v2,omitempty"`
EndTime *float32 `json:"end_time,omitempty"`
GrossWeight *NumberAreaConditionField `json:"gross_weight,omitempty"`
Merchant *StringConditionField `json:"merchant,omitempty"`
OrderType *StringConditionField `json:"order_type,omitempty"`
OrderValueMax *float32 `json:"order_value_max,omitempty"`
OrderValueMin *float32 `json:"order_value_min,omitempty"`
ParcelCount *NumberAreaConditionField `json:"parcel_count,omitempty"`
PaymentType *StringConditionField `json:"payment_type,omitempty"`
PickupPartnerLocationIds *StringConditionField `json:"pickup_partner_location_ids,omitempty"`
PickupV2 *GeographyConditionField `json:"pickup_v2,omitempty"`
RuleId *string `json:"rule_id,omitempty"`
RuleName *string `json:"rule_name,omitempty"`
RuleSetId *string `json:"rule_set_id,omitempty"`
Sequence *float32 `json:"sequence,omitempty"`
SourceType *StringConditionField `json:"source_type,omitempty"`
StartTime *float32 `json:"start_time,omitempty"`
Status *StatusField `json:"status,omitempty"`
Tenant *string `json:"tenant,omitempty"`
UpdateDate *time.Time `json:"update_date,omitempty"`
VolumetricWeight *NumberAreaConditionField `json:"volumetric_weight,omitempty"`
}
AutomationRuleResponse defines model for automation-rule-response.
type AutomationRuleResponseCarrierChoice ¶
type AutomationRuleResponseCarrierChoice string
AutomationRuleResponseCarrierChoice defines model for AutomationRuleResponse.CarrierChoice.
const (
AutomationRuleResponseCarrierChoiceCHEAPESTCARRIER AutomationRuleResponseCarrierChoice = "CHEAPEST_CARRIER"
)
Defines values for AutomationRuleResponseCarrierChoice.
type AutomationRulesetWithRulesRequest ¶
type AutomationRulesetWithRulesRequest struct {
AutomationRuleSet RulesetRequest `json:"automation_rule_set"`
AutomationRules *[]AutomationRuleRequest `json:"automation_rules,omitempty"`
}
AutomationRulesetWithRulesRequest defines model for automation-ruleset-with-rules-request.
type AutomationRulesetWithRulesResponse ¶
type AutomationRulesetWithRulesResponse struct {
AutomationRuleSet RulesetResponse `json:"automation_rule_set"`
AutomationRules *[]AutomationRuleResponse `json:"automation_rules,omitempty"`
}
AutomationRulesetWithRulesResponse defines model for automation-ruleset-with-rules-response.
type BreakdownObject ¶
type BreakdownObject struct {
Amount *float32 `json:"amount,omitempty"`
Currency *string `json:"currency,omitempty"`
Description *string `json:"description,omitempty"`
}
BreakdownObject The estimated cost of the shipping based either on the costing profile you have configured for the carrier or carrier costing API response
type BulkShipmentStatusResponse ¶
type BulkShipmentStatusResponse struct {
// Milestones The list of all shipment statuses
Milestones *[]struct {
Date *string `json:"date,omitempty"`
Status *CarriyoResponseStatus `json:"status,omitempty"`
} `json:"milestones,omitempty"`
ShipmentId *string `json:"shipmentId,omitempty"`
Status *CarriyoResponseStatus `json:"status,omitempty"`
}
BulkShipmentStatusResponse defines model for bulk-shipment-status-response.
type CancelManifestParams ¶
type CancelManifestParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CancelManifestParams defines parameters for CancelManifest.
type CancelManifestResponse ¶
type CancelManifestResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
}
func ParseCancelManifestResponse ¶
func ParseCancelManifestResponse(rsp *http.Response) (*CancelManifestResponse, error)
ParseCancelManifestResponse parses an HTTP response from a CancelManifestWithResponse call
func (CancelManifestResponse) Status ¶
func (r CancelManifestResponse) Status() string
Status returns HTTPResponse.Status
func (CancelManifestResponse) StatusCode ¶
func (r CancelManifestResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CancelShipmentJSONBody ¶
type CancelShipmentJSONBody struct {
// UpdateReasonCode Any one of the standard reason codes (below) or custom reason codes defined by the merchant.
//
// [Click here for the list of Standard Reason Codes](/guides/shipment-reason-codes/)
UpdateReasonCode *string `json:"update_reason_code,omitempty"`
}
CancelShipmentJSONBody defines parameters for CancelShipment.
type CancelShipmentJSONRequestBody ¶
type CancelShipmentJSONRequestBody CancelShipmentJSONBody
CancelShipmentJSONRequestBody defines body for CancelShipment for application/json ContentType.
type CancelShipmentParams ¶
type CancelShipmentParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CancelShipmentParams defines parameters for CancelShipment.
type CancelShipmentResponse ¶
type CancelShipmentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
JSON400 *struct {
Errors *[]string `json:"errors,omitempty"`
Status *string `json:"status,omitempty"`
Timestamp *string `json:"timestamp,omitempty"`
}
}
func ParseCancelShipmentResponse ¶
func ParseCancelShipmentResponse(rsp *http.Response) (*CancelShipmentResponse, error)
ParseCancelShipmentResponse parses an HTTP response from a CancelShipmentWithResponse call
func (CancelShipmentResponse) Status ¶
func (r CancelShipmentResponse) Status() string
Status returns HTTPResponse.Status
func (CancelShipmentResponse) StatusCode ¶
func (r CancelShipmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CarrierAccountEndpointObject ¶
type CarrierAccountEndpointObject struct {
AutoReadyToShip *bool `json:"auto_ready_to_ship,omitempty"`
AutoReturnConfirmed *bool `json:"auto_return_confirmed,omitempty"`
AutoTranslateToEnglish *bool `json:"auto_translate_to_english,omitempty"`
Carrier *string `json:"carrier,omitempty"`
CarrierAccountId *string `json:"carrier_account_id,omitempty"`
CarrierAccountName *string `json:"carrier_account_name,omitempty"`
CostingProfileId *string `json:"costing_profile_id,omitempty"`
DailyCapacityId *string `json:"daily_capacity_id,omitempty"`
Deleted *bool `json:"deleted,omitempty"`
InFlightCapacityId *string `json:"in_flight_capacity_id,omitempty"`
Label *struct {
DefaultLabel *string `json:"default_label,omitempty"`
} `json:"label,omitempty"`
NetworkId *string `json:"network_id,omitempty"`
Property *map[string]interface{} `json:"property,omitempty"`
UpdateDate *string `json:"update_date,omitempty"`
}
CarrierAccountEndpointObject defines model for carrier-account-endpoint-object.
type CarrierAccountEndpointRequest ¶
type CarrierAccountEndpointRequest struct {
AutoReadyToShip *bool `json:"auto_ready_to_ship,omitempty"`
AutoReturnConfirmed *bool `json:"auto_return_confirmed,omitempty"`
AutoTranslateToEnglish *bool `json:"auto_translate_to_english,omitempty"`
Carrier *string `json:"carrier,omitempty"`
CarrierAccountId *string `json:"carrier_account_id,omitempty"`
CarrierAccountName *string `json:"carrier_account_name,omitempty"`
CostingProfileId *string `json:"costing_profile_id,omitempty"`
DailyCapacityId *string `json:"daily_capacity_id,omitempty"`
InFlightCapacityId *string `json:"in_flight_capacity_id,omitempty"`
Label *struct {
DefaultLabel *string `json:"default_label,omitempty"`
} `json:"label,omitempty"`
NetworkId *string `json:"network_id,omitempty"`
Property *map[string]interface{} `json:"property,omitempty"`
}
CarrierAccountEndpointRequest defines model for carrier-account-endpoint-request.
type CarrierAccountObject ¶
type CarrierAccountObject struct {
// Carrier The actual carrier based on the carrier account assigned to the shipment
Carrier *string `json:"carrier,omitempty"`
// CarrierAccountName The name of the carrier account assigned to the shipment
CarrierAccountName *string `json:"carrier_account_name,omitempty"`
// CarrierId The id of the carrier account assigned to the shipment
CarrierId *string `json:"carrier_id,omitempty"`
}
CarrierAccountObject Carrier account chosen for the shipment.
type CarrierAccountRequest ¶
type CarrierAccountRequest struct {
// CarrierAccountName The name of the carrier account assigned to the shipment
CarrierAccountName *string `json:"carrier_account_name,omitempty"`
// CarrierId The ID of the carrier account assigned to the shipment
CarrierId *string `json:"carrier_id,omitempty"`
}
CarrierAccountRequest Carrier account chosen for the shipment. Should contain either the carrier account id or carrier account name. Carrier account id takes precedence if both fields are passed.
type CarriyoResponseStatus ¶
type CarriyoResponseStatus string
CarriyoResponseStatus defines model for carriyo-response-status.
const ( AwaitingCustomerCollection CarriyoResponseStatus = "awaiting_customer_collection" Booked CarriyoResponseStatus = "booked" Cancelled CarriyoResponseStatus = "cancelled" CancelledByCarrier CarriyoResponseStatus = "cancelled_by_carrier" Delayed CarriyoResponseStatus = "delayed" Delivered CarriyoResponseStatus = "delivered" DeliveryConfirmed CarriyoResponseStatus = "delivery_confirmed" Error CarriyoResponseStatus = "error" FailedCollectionAttempt CarriyoResponseStatus = "failed_collection_attempt" FailedDeliveryAttempt CarriyoResponseStatus = "failed_delivery_attempt" InTransit CarriyoResponseStatus = "in_transit" Missing CarriyoResponseStatus = "missing" OutForDelivery CarriyoResponseStatus = "out_for_delivery" Pending CarriyoResponseStatus = "pending" ReadyForReturn CarriyoResponseStatus = "ready_for_return" ReadyToShip CarriyoResponseStatus = "ready-to-ship" ReturnConfirmed CarriyoResponseStatus = "return_confirmed" ReturnInTransit CarriyoResponseStatus = "return_in_transit" Returned CarriyoResponseStatus = "returned" Shipped CarriyoResponseStatus = "shipped" Suspended CarriyoResponseStatus = "suspended" )
Defines values for CarriyoResponseStatus.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) CancelManifest ¶
func (c *Client) CancelManifest(ctx context.Context, manifestId string, params *CancelManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CancelShipment ¶
func (c *Client) CancelShipment(ctx context.Context, shipmentId string, params *CancelShipmentParams, body CancelShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CancelShipmentWithBody ¶
func (*Client) ConfirmShipment ¶
func (c *Client) ConfirmShipment(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, body ConfirmShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ConfirmShipmentWithBody ¶
func (*Client) CreateAttribute ¶
func (c *Client) CreateAttribute(ctx context.Context, params *CreateAttributeParams, body CreateAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateAttributeWithBody ¶
func (*Client) CreateAutomationRules ¶
func (c *Client) CreateAutomationRules(ctx context.Context, automationRulesetId string, params *CreateAutomationRulesParams, body CreateAutomationRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateAutomationRulesWithBody ¶
func (*Client) CreateAutomationRulesetAndRules ¶
func (c *Client) CreateAutomationRulesetAndRules(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, body CreateAutomationRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateAutomationRulesetAndRulesWithBody ¶
func (*Client) CreateCarrierAccount ¶
func (c *Client) CreateCarrierAccount(ctx context.Context, params *CreateCarrierAccountParams, body CreateCarrierAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateCarrierAccountWithBody ¶
func (*Client) CreateManifest ¶
func (c *Client) CreateManifest(ctx context.Context, params *CreateManifestParams, body CreateManifestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateManifestWithBody ¶
func (*Client) CreateServiceLevelRules ¶
func (c *Client) CreateServiceLevelRules(ctx context.Context, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, body CreateServiceLevelRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateServiceLevelRulesWithBody ¶
func (*Client) CreateServiceLevelRulesetAndRules ¶
func (c *Client) CreateServiceLevelRulesetAndRules(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, body CreateServiceLevelRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateServiceLevelRulesetAndRulesWithBody ¶
func (*Client) CreateShipment ¶
func (c *Client) CreateShipment(ctx context.Context, params *CreateShipmentParams, body CreateShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateShipmentWithBody ¶
func (*Client) DeleteAttribute ¶
func (c *Client) DeleteAttribute(ctx context.Context, attributeId string, params *DeleteAttributeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteAutomationRule ¶
func (c *Client) DeleteAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, params *DeleteAutomationRuleParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteAutomationRuleset ¶
func (c *Client) DeleteAutomationRuleset(ctx context.Context, automationRulesetId string, params *DeleteAutomationRulesetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteCarrierAccount ¶
func (c *Client) DeleteCarrierAccount(ctx context.Context, carrierAccountId string, params *DeleteCarrierAccountParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteManifest ¶
func (c *Client) DeleteManifest(ctx context.Context, manifestId string, params *DeleteManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteServiceLevelRule ¶
func (c *Client) DeleteServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *DeleteServiceLevelRuleParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteServiceLevelRuleset ¶
func (c *Client) DeleteServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, params *DeleteServiceLevelRulesetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) EstimateShippingCostForShipment ¶
func (c *Client) EstimateShippingCostForShipment(ctx context.Context, shipmentId string, params *EstimateShippingCostForShipmentParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetAccessToken ¶ added in v0.3.0
func (c *Client) GetAccessToken(ctx context.Context, body GetAccessTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetAccessTokenWithBody ¶ added in v0.3.0
func (*Client) GetAttribute ¶
func (c *Client) GetAttribute(ctx context.Context, attributeId string, params *GetAttributeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetAutomationRule ¶
func (c *Client) GetAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, params *GetAutomationRuleParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetAutomationRuleset ¶
func (c *Client) GetAutomationRuleset(ctx context.Context, automationRulesetId string, params *GetAutomationRulesetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetBulkStatus ¶
func (c *Client) GetBulkStatus(ctx context.Context, params *GetBulkStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetCarrierAccount ¶
func (c *Client) GetCarrierAccount(ctx context.Context, carrierAccountId string, params *GetCarrierAccountParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetManifest ¶
func (c *Client) GetManifest(ctx context.Context, manifestId string, params *GetManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetServiceLevelRule ¶
func (c *Client) GetServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *GetServiceLevelRuleParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetServiceLevelRuleset ¶
func (c *Client) GetServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, params *GetServiceLevelRulesetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetShipment ¶
func (c *Client) GetShipment(ctx context.Context, shipmentId string, params *GetShipmentParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetShippingRates ¶
func (c *Client) GetShippingRates(ctx context.Context, params *GetShippingRatesParams, body GetShippingRatesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetShippingRatesWithBody ¶
func (*Client) ListAttrbutes ¶
func (c *Client) ListAttrbutes(ctx context.Context, params *ListAttrbutesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListAutomationRules ¶
func (c *Client) ListAutomationRules(ctx context.Context, automationRulesetId string, params *ListAutomationRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListAutomationRulesets ¶
func (c *Client) ListAutomationRulesets(ctx context.Context, params *ListAutomationRulesetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListCarrierAccounts ¶
func (c *Client) ListCarrierAccounts(ctx context.Context, params *ListCarrierAccountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListManifests ¶
func (c *Client) ListManifests(ctx context.Context, params *ListManifestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListServiceLevelRules ¶
func (c *Client) ListServiceLevelRules(ctx context.Context, serviceLevelRulesetId string, params *ListServiceLevelRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListServiceLevelRulesets ¶
func (c *Client) ListServiceLevelRulesets(ctx context.Context, params *ListServiceLevelRulesetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListShipments ¶
func (c *Client) ListShipments(ctx context.Context, params *ListShipmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PatchAutomationRuleset ¶
func (c *Client) PatchAutomationRuleset(ctx context.Context, automationRulesetId string, params *PatchAutomationRulesetParams, body PatchAutomationRulesetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PatchAutomationRulesetWithBody ¶
func (*Client) PatchServiceLevelRuleset ¶
func (c *Client) PatchServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, body PatchServiceLevelRulesetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PatchServiceLevelRulesetWithBody ¶
func (*Client) ReadyToShip ¶
func (c *Client) ReadyToShip(ctx context.Context, shipmentId string, params *ReadyToShipParams, body ReadyToShipJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ReadyToShipWithBody ¶
func (*Client) ReassignShipment ¶
func (c *Client) ReassignShipment(ctx context.Context, shipmentId string, params *ReassignShipmentParams, body ReassignShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ReassignShipmentWithBody ¶
func (*Client) RefreshLabel ¶
func (c *Client) RefreshLabel(ctx context.Context, shipmentId string, params *RefreshLabelParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ReprocessShipment ¶
func (c *Client) ReprocessShipment(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, body ReprocessShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ReprocessShipmentWithBody ¶
func (*Client) RetryManifest ¶
func (c *Client) RetryManifest(ctx context.Context, manifestId string, params *RetryManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ShipManifest ¶
func (c *Client) ShipManifest(ctx context.Context, manifestId string, params *ShipManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateAttribute ¶
func (c *Client) UpdateAttribute(ctx context.Context, attributeId string, params *UpdateAttributeParams, body UpdateAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateAttributeWithBody ¶
func (*Client) UpdateAutomationRule ¶
func (c *Client) UpdateAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, body UpdateAutomationRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateAutomationRuleWithBody ¶
func (*Client) UpdateAutomationRulesSequence ¶
func (c *Client) UpdateAutomationRulesSequence(ctx context.Context, rulesetId string, params *UpdateAutomationRulesSequenceParams, body UpdateAutomationRulesSequenceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateAutomationRulesSequenceWithBody ¶
func (*Client) UpdateAutomationRulesetAndRules ¶
func (c *Client) UpdateAutomationRulesetAndRules(ctx context.Context, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, body UpdateAutomationRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateAutomationRulesetAndRulesWithBody ¶
func (*Client) UpdateCarrierAccount ¶
func (c *Client) UpdateCarrierAccount(ctx context.Context, carrierAccountId string, params *UpdateCarrierAccountParams, body UpdateCarrierAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateCarrierAccountWithBody ¶
func (*Client) UpdateCollectionSchedule ¶
func (c *Client) UpdateCollectionSchedule(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, body UpdateCollectionScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateCollectionScheduleWithBody ¶
func (*Client) UpdateDeliveryPromise ¶
func (c *Client) UpdateDeliveryPromise(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, body UpdateDeliveryPromiseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateDeliveryPromiseWithBody ¶
func (*Client) UpdateDeliverySchedule ¶
func (c *Client) UpdateDeliverySchedule(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, body UpdateDeliveryScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateDeliveryScheduleWithBody ¶
func (*Client) UpdateParcels ¶
func (c *Client) UpdateParcels(ctx context.Context, shipmentId string, params *UpdateParcelsParams, body UpdateParcelsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateParcelsWithBody ¶
func (*Client) UpdateServiceLevelRule ¶
func (c *Client) UpdateServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, body UpdateServiceLevelRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateServiceLevelRuleWithBody ¶
func (*Client) UpdateServiceLevelRulesSequence ¶
func (c *Client) UpdateServiceLevelRulesSequence(ctx context.Context, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, body UpdateServiceLevelRulesSequenceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateServiceLevelRulesSequenceWithBody ¶
func (*Client) UpdateServiceLevelRulesetAndRules ¶
func (c *Client) UpdateServiceLevelRulesetAndRules(ctx context.Context, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, body UpdateServiceLevelRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateServiceLevelRulesetAndRulesWithBody ¶
func (*Client) UpdateShipment ¶
func (c *Client) UpdateShipment(ctx context.Context, shipmentId string, params *UpdateShipmentParams, body UpdateShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateShipmentPatch ¶
func (c *Client) UpdateShipmentPatch(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, body UpdateShipmentPatchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateShipmentPatchWithBody ¶
func (*Client) UpdateShipmentWithBody ¶
func (*Client) UpdateStatus ¶
func (c *Client) UpdateStatus(ctx context.Context, shipmentId string, params *UpdateStatusParams, body UpdateStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateStatusWithBody ¶
type ClientInterface ¶
type ClientInterface interface {
// ListAttrbutes request
ListAttrbutes(ctx context.Context, params *ListAttrbutesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateAttributeWithBody request with any body
CreateAttributeWithBody(ctx context.Context, params *CreateAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateAttribute(ctx context.Context, params *CreateAttributeParams, body CreateAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteAttribute request
DeleteAttribute(ctx context.Context, attributeId string, params *DeleteAttributeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetAttribute request
GetAttribute(ctx context.Context, attributeId string, params *GetAttributeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateAttributeWithBody request with any body
UpdateAttributeWithBody(ctx context.Context, attributeId string, params *UpdateAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateAttribute(ctx context.Context, attributeId string, params *UpdateAttributeParams, body UpdateAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListAutomationRulesets request
ListAutomationRulesets(ctx context.Context, params *ListAutomationRulesetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateAutomationRulesetAndRulesWithBody request with any body
CreateAutomationRulesetAndRulesWithBody(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateAutomationRulesetAndRules(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, body CreateAutomationRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteAutomationRuleset request
DeleteAutomationRuleset(ctx context.Context, automationRulesetId string, params *DeleteAutomationRulesetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetAutomationRuleset request
GetAutomationRuleset(ctx context.Context, automationRulesetId string, params *GetAutomationRulesetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchAutomationRulesetWithBody request with any body
PatchAutomationRulesetWithBody(ctx context.Context, automationRulesetId string, params *PatchAutomationRulesetParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchAutomationRuleset(ctx context.Context, automationRulesetId string, params *PatchAutomationRulesetParams, body PatchAutomationRulesetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateAutomationRulesetAndRulesWithBody request with any body
UpdateAutomationRulesetAndRulesWithBody(ctx context.Context, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateAutomationRulesetAndRules(ctx context.Context, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, body UpdateAutomationRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListAutomationRules request
ListAutomationRules(ctx context.Context, automationRulesetId string, params *ListAutomationRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateAutomationRulesWithBody request with any body
CreateAutomationRulesWithBody(ctx context.Context, automationRulesetId string, params *CreateAutomationRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateAutomationRules(ctx context.Context, automationRulesetId string, params *CreateAutomationRulesParams, body CreateAutomationRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateAutomationRulesSequenceWithBody request with any body
UpdateAutomationRulesSequenceWithBody(ctx context.Context, rulesetId string, params *UpdateAutomationRulesSequenceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateAutomationRulesSequence(ctx context.Context, rulesetId string, params *UpdateAutomationRulesSequenceParams, body UpdateAutomationRulesSequenceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteAutomationRule request
DeleteAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, params *DeleteAutomationRuleParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetAutomationRule request
GetAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, params *GetAutomationRuleParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateAutomationRuleWithBody request with any body
UpdateAutomationRuleWithBody(ctx context.Context, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateAutomationRule(ctx context.Context, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, body UpdateAutomationRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListCarrierAccounts request
ListCarrierAccounts(ctx context.Context, params *ListCarrierAccountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateCarrierAccountWithBody request with any body
CreateCarrierAccountWithBody(ctx context.Context, params *CreateCarrierAccountParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateCarrierAccount(ctx context.Context, params *CreateCarrierAccountParams, body CreateCarrierAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteCarrierAccount request
DeleteCarrierAccount(ctx context.Context, carrierAccountId string, params *DeleteCarrierAccountParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetCarrierAccount request
GetCarrierAccount(ctx context.Context, carrierAccountId string, params *GetCarrierAccountParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateCarrierAccountWithBody request with any body
UpdateCarrierAccountWithBody(ctx context.Context, carrierAccountId string, params *UpdateCarrierAccountParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateCarrierAccount(ctx context.Context, carrierAccountId string, params *UpdateCarrierAccountParams, body UpdateCarrierAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetShippingRatesWithBody request with any body
GetShippingRatesWithBody(ctx context.Context, params *GetShippingRatesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
GetShippingRates(ctx context.Context, params *GetShippingRatesParams, body GetShippingRatesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListManifests request
ListManifests(ctx context.Context, params *ListManifestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateManifestWithBody request with any body
CreateManifestWithBody(ctx context.Context, params *CreateManifestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateManifest(ctx context.Context, params *CreateManifestParams, body CreateManifestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteManifest request
DeleteManifest(ctx context.Context, manifestId string, params *DeleteManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetManifest request
GetManifest(ctx context.Context, manifestId string, params *GetManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CancelManifest request
CancelManifest(ctx context.Context, manifestId string, params *CancelManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// RetryManifest request
RetryManifest(ctx context.Context, manifestId string, params *RetryManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// ShipManifest request
ShipManifest(ctx context.Context, manifestId string, params *ShipManifestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetAccessTokenWithBody request with any body
GetAccessTokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
GetAccessToken(ctx context.Context, body GetAccessTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListServiceLevelRulesets request
ListServiceLevelRulesets(ctx context.Context, params *ListServiceLevelRulesetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateServiceLevelRulesetAndRulesWithBody request with any body
CreateServiceLevelRulesetAndRulesWithBody(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateServiceLevelRulesetAndRules(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, body CreateServiceLevelRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateServiceLevelRulesSequenceWithBody request with any body
UpdateServiceLevelRulesSequenceWithBody(ctx context.Context, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateServiceLevelRulesSequence(ctx context.Context, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, body UpdateServiceLevelRulesSequenceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteServiceLevelRule request
DeleteServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *DeleteServiceLevelRuleParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetServiceLevelRule request
GetServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *GetServiceLevelRuleParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateServiceLevelRuleWithBody request with any body
UpdateServiceLevelRuleWithBody(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateServiceLevelRule(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, body UpdateServiceLevelRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteServiceLevelRuleset request
DeleteServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, params *DeleteServiceLevelRulesetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetServiceLevelRuleset request
GetServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, params *GetServiceLevelRulesetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchServiceLevelRulesetWithBody request with any body
PatchServiceLevelRulesetWithBody(ctx context.Context, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchServiceLevelRuleset(ctx context.Context, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, body PatchServiceLevelRulesetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateServiceLevelRulesetAndRulesWithBody request with any body
UpdateServiceLevelRulesetAndRulesWithBody(ctx context.Context, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateServiceLevelRulesetAndRules(ctx context.Context, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, body UpdateServiceLevelRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListServiceLevelRules request
ListServiceLevelRules(ctx context.Context, serviceLevelRulesetId string, params *ListServiceLevelRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateServiceLevelRulesWithBody request with any body
CreateServiceLevelRulesWithBody(ctx context.Context, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateServiceLevelRules(ctx context.Context, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, body CreateServiceLevelRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListShipments request
ListShipments(ctx context.Context, params *ListShipmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateShipmentWithBody request with any body
CreateShipmentWithBody(ctx context.Context, params *CreateShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateShipment(ctx context.Context, params *CreateShipmentParams, body CreateShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetBulkStatus request
GetBulkStatus(ctx context.Context, params *GetBulkStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetShipment request
GetShipment(ctx context.Context, shipmentId string, params *GetShipmentParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateShipmentPatchWithBody request with any body
UpdateShipmentPatchWithBody(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateShipmentPatch(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, body UpdateShipmentPatchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateShipmentWithBody request with any body
UpdateShipmentWithBody(ctx context.Context, shipmentId string, params *UpdateShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateShipment(ctx context.Context, shipmentId string, params *UpdateShipmentParams, body UpdateShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// CancelShipmentWithBody request with any body
CancelShipmentWithBody(ctx context.Context, shipmentId string, params *CancelShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CancelShipment(ctx context.Context, shipmentId string, params *CancelShipmentParams, body CancelShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ConfirmShipmentWithBody request with any body
ConfirmShipmentWithBody(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ConfirmShipment(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, body ConfirmShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// EstimateShippingCostForShipment request
EstimateShippingCostForShipment(ctx context.Context, shipmentId string, params *EstimateShippingCostForShipmentParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// RefreshLabel request
RefreshLabel(ctx context.Context, shipmentId string, params *RefreshLabelParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateParcelsWithBody request with any body
UpdateParcelsWithBody(ctx context.Context, shipmentId string, params *UpdateParcelsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateParcels(ctx context.Context, shipmentId string, params *UpdateParcelsParams, body UpdateParcelsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ReadyToShipWithBody request with any body
ReadyToShipWithBody(ctx context.Context, shipmentId string, params *ReadyToShipParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ReadyToShip(ctx context.Context, shipmentId string, params *ReadyToShipParams, body ReadyToShipJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ReassignShipmentWithBody request with any body
ReassignShipmentWithBody(ctx context.Context, shipmentId string, params *ReassignShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ReassignShipment(ctx context.Context, shipmentId string, params *ReassignShipmentParams, body ReassignShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ReprocessShipmentWithBody request with any body
ReprocessShipmentWithBody(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ReprocessShipment(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, body ReprocessShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateCollectionScheduleWithBody request with any body
UpdateCollectionScheduleWithBody(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateCollectionSchedule(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, body UpdateCollectionScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateDeliveryPromiseWithBody request with any body
UpdateDeliveryPromiseWithBody(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateDeliveryPromise(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, body UpdateDeliveryPromiseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateDeliveryScheduleWithBody request with any body
UpdateDeliveryScheduleWithBody(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateDeliverySchedule(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, body UpdateDeliveryScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateStatusWithBody request with any body
UpdateStatusWithBody(ctx context.Context, shipmentId string, params *UpdateStatusParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateStatus(ctx context.Context, shipmentId string, params *UpdateStatusParams, body UpdateStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) CancelManifestWithResponse ¶
func (c *ClientWithResponses) CancelManifestWithResponse(ctx context.Context, manifestId string, params *CancelManifestParams, reqEditors ...RequestEditorFn) (*CancelManifestResponse, error)
CancelManifestWithResponse request returning *CancelManifestResponse
func (*ClientWithResponses) CancelShipmentWithBodyWithResponse ¶
func (c *ClientWithResponses) CancelShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CancelShipmentResponse, error)
CancelShipmentWithBodyWithResponse request with arbitrary body returning *CancelShipmentResponse
func (*ClientWithResponses) CancelShipmentWithResponse ¶
func (c *ClientWithResponses) CancelShipmentWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams, body CancelShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*CancelShipmentResponse, error)
func (*ClientWithResponses) ConfirmShipmentWithBodyWithResponse ¶
func (c *ClientWithResponses) ConfirmShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConfirmShipmentResponse, error)
ConfirmShipmentWithBodyWithResponse request with arbitrary body returning *ConfirmShipmentResponse
func (*ClientWithResponses) ConfirmShipmentWithResponse ¶
func (c *ClientWithResponses) ConfirmShipmentWithResponse(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, body ConfirmShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*ConfirmShipmentResponse, error)
func (*ClientWithResponses) CreateAttributeWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateAttributeWithBodyWithResponse(ctx context.Context, params *CreateAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAttributeResponse, error)
CreateAttributeWithBodyWithResponse request with arbitrary body returning *CreateAttributeResponse
func (*ClientWithResponses) CreateAttributeWithResponse ¶
func (c *ClientWithResponses) CreateAttributeWithResponse(ctx context.Context, params *CreateAttributeParams, body CreateAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAttributeResponse, error)
func (*ClientWithResponses) CreateAutomationRulesWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateAutomationRulesWithBodyWithResponse(ctx context.Context, automationRulesetId string, params *CreateAutomationRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAutomationRulesResponse, error)
CreateAutomationRulesWithBodyWithResponse request with arbitrary body returning *CreateAutomationRulesResponse
func (*ClientWithResponses) CreateAutomationRulesWithResponse ¶
func (c *ClientWithResponses) CreateAutomationRulesWithResponse(ctx context.Context, automationRulesetId string, params *CreateAutomationRulesParams, body CreateAutomationRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAutomationRulesResponse, error)
func (*ClientWithResponses) CreateAutomationRulesetAndRulesWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateAutomationRulesetAndRulesWithBodyWithResponse(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAutomationRulesetAndRulesResponse, error)
CreateAutomationRulesetAndRulesWithBodyWithResponse request with arbitrary body returning *CreateAutomationRulesetAndRulesResponse
func (*ClientWithResponses) CreateAutomationRulesetAndRulesWithResponse ¶
func (c *ClientWithResponses) CreateAutomationRulesetAndRulesWithResponse(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, body CreateAutomationRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAutomationRulesetAndRulesResponse, error)
func (*ClientWithResponses) CreateCarrierAccountWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateCarrierAccountWithBodyWithResponse(ctx context.Context, params *CreateCarrierAccountParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCarrierAccountResponse, error)
CreateCarrierAccountWithBodyWithResponse request with arbitrary body returning *CreateCarrierAccountResponse
func (*ClientWithResponses) CreateCarrierAccountWithResponse ¶
func (c *ClientWithResponses) CreateCarrierAccountWithResponse(ctx context.Context, params *CreateCarrierAccountParams, body CreateCarrierAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCarrierAccountResponse, error)
func (*ClientWithResponses) CreateManifestWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateManifestWithBodyWithResponse(ctx context.Context, params *CreateManifestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateManifestResponse, error)
CreateManifestWithBodyWithResponse request with arbitrary body returning *CreateManifestResponse
func (*ClientWithResponses) CreateManifestWithResponse ¶
func (c *ClientWithResponses) CreateManifestWithResponse(ctx context.Context, params *CreateManifestParams, body CreateManifestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateManifestResponse, error)
func (*ClientWithResponses) CreateServiceLevelRulesWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateServiceLevelRulesWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServiceLevelRulesResponse, error)
CreateServiceLevelRulesWithBodyWithResponse request with arbitrary body returning *CreateServiceLevelRulesResponse
func (*ClientWithResponses) CreateServiceLevelRulesWithResponse ¶
func (c *ClientWithResponses) CreateServiceLevelRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, body CreateServiceLevelRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServiceLevelRulesResponse, error)
func (*ClientWithResponses) CreateServiceLevelRulesetAndRulesWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateServiceLevelRulesetAndRulesWithBodyWithResponse(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServiceLevelRulesetAndRulesResponse, error)
CreateServiceLevelRulesetAndRulesWithBodyWithResponse request with arbitrary body returning *CreateServiceLevelRulesetAndRulesResponse
func (*ClientWithResponses) CreateServiceLevelRulesetAndRulesWithResponse ¶
func (c *ClientWithResponses) CreateServiceLevelRulesetAndRulesWithResponse(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, body CreateServiceLevelRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServiceLevelRulesetAndRulesResponse, error)
func (*ClientWithResponses) CreateShipmentWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateShipmentWithBodyWithResponse(ctx context.Context, params *CreateShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateShipmentResponse, error)
CreateShipmentWithBodyWithResponse request with arbitrary body returning *CreateShipmentResponse
func (*ClientWithResponses) CreateShipmentWithResponse ¶
func (c *ClientWithResponses) CreateShipmentWithResponse(ctx context.Context, params *CreateShipmentParams, body CreateShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateShipmentResponse, error)
func (*ClientWithResponses) DeleteAttributeWithResponse ¶
func (c *ClientWithResponses) DeleteAttributeWithResponse(ctx context.Context, attributeId string, params *DeleteAttributeParams, reqEditors ...RequestEditorFn) (*DeleteAttributeResponse, error)
DeleteAttributeWithResponse request returning *DeleteAttributeResponse
func (*ClientWithResponses) DeleteAutomationRuleWithResponse ¶
func (c *ClientWithResponses) DeleteAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, params *DeleteAutomationRuleParams, reqEditors ...RequestEditorFn) (*DeleteAutomationRuleResponse, error)
DeleteAutomationRuleWithResponse request returning *DeleteAutomationRuleResponse
func (*ClientWithResponses) DeleteAutomationRulesetWithResponse ¶
func (c *ClientWithResponses) DeleteAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, params *DeleteAutomationRulesetParams, reqEditors ...RequestEditorFn) (*DeleteAutomationRulesetResponse, error)
DeleteAutomationRulesetWithResponse request returning *DeleteAutomationRulesetResponse
func (*ClientWithResponses) DeleteCarrierAccountWithResponse ¶
func (c *ClientWithResponses) DeleteCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, params *DeleteCarrierAccountParams, reqEditors ...RequestEditorFn) (*DeleteCarrierAccountResponse, error)
DeleteCarrierAccountWithResponse request returning *DeleteCarrierAccountResponse
func (*ClientWithResponses) DeleteManifestWithResponse ¶
func (c *ClientWithResponses) DeleteManifestWithResponse(ctx context.Context, manifestId string, params *DeleteManifestParams, reqEditors ...RequestEditorFn) (*DeleteManifestResponse, error)
DeleteManifestWithResponse request returning *DeleteManifestResponse
func (*ClientWithResponses) DeleteServiceLevelRuleWithResponse ¶
func (c *ClientWithResponses) DeleteServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *DeleteServiceLevelRuleParams, reqEditors ...RequestEditorFn) (*DeleteServiceLevelRuleResponse, error)
DeleteServiceLevelRuleWithResponse request returning *DeleteServiceLevelRuleResponse
func (*ClientWithResponses) DeleteServiceLevelRulesetWithResponse ¶
func (c *ClientWithResponses) DeleteServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, params *DeleteServiceLevelRulesetParams, reqEditors ...RequestEditorFn) (*DeleteServiceLevelRulesetResponse, error)
DeleteServiceLevelRulesetWithResponse request returning *DeleteServiceLevelRulesetResponse
func (*ClientWithResponses) EstimateShippingCostForShipmentWithResponse ¶
func (c *ClientWithResponses) EstimateShippingCostForShipmentWithResponse(ctx context.Context, shipmentId string, params *EstimateShippingCostForShipmentParams, reqEditors ...RequestEditorFn) (*EstimateShippingCostForShipmentResponse, error)
EstimateShippingCostForShipmentWithResponse request returning *EstimateShippingCostForShipmentResponse
func (*ClientWithResponses) GetAccessTokenWithBodyWithResponse ¶ added in v0.3.0
func (c *ClientWithResponses) GetAccessTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetAccessTokenResponse, error)
GetAccessTokenWithBodyWithResponse request with arbitrary body returning *GetAccessTokenResponse
func (*ClientWithResponses) GetAccessTokenWithResponse ¶ added in v0.3.0
func (c *ClientWithResponses) GetAccessTokenWithResponse(ctx context.Context, body GetAccessTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*GetAccessTokenResponse, error)
func (*ClientWithResponses) GetAttributeWithResponse ¶
func (c *ClientWithResponses) GetAttributeWithResponse(ctx context.Context, attributeId string, params *GetAttributeParams, reqEditors ...RequestEditorFn) (*GetAttributeResponse, error)
GetAttributeWithResponse request returning *GetAttributeResponse
func (*ClientWithResponses) GetAutomationRuleWithResponse ¶
func (c *ClientWithResponses) GetAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, params *GetAutomationRuleParams, reqEditors ...RequestEditorFn) (*GetAutomationRuleResponse, error)
GetAutomationRuleWithResponse request returning *GetAutomationRuleResponse
func (*ClientWithResponses) GetAutomationRulesetWithResponse ¶
func (c *ClientWithResponses) GetAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, params *GetAutomationRulesetParams, reqEditors ...RequestEditorFn) (*GetAutomationRulesetResponse, error)
GetAutomationRulesetWithResponse request returning *GetAutomationRulesetResponse
func (*ClientWithResponses) GetBulkStatusWithResponse ¶
func (c *ClientWithResponses) GetBulkStatusWithResponse(ctx context.Context, params *GetBulkStatusParams, reqEditors ...RequestEditorFn) (*GetBulkStatusResponse, error)
GetBulkStatusWithResponse request returning *GetBulkStatusResponse
func (*ClientWithResponses) GetCarrierAccountWithResponse ¶
func (c *ClientWithResponses) GetCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, params *GetCarrierAccountParams, reqEditors ...RequestEditorFn) (*GetCarrierAccountResponse, error)
GetCarrierAccountWithResponse request returning *GetCarrierAccountResponse
func (*ClientWithResponses) GetManifestWithResponse ¶
func (c *ClientWithResponses) GetManifestWithResponse(ctx context.Context, manifestId string, params *GetManifestParams, reqEditors ...RequestEditorFn) (*GetManifestResponse, error)
GetManifestWithResponse request returning *GetManifestResponse
func (*ClientWithResponses) GetServiceLevelRuleWithResponse ¶
func (c *ClientWithResponses) GetServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *GetServiceLevelRuleParams, reqEditors ...RequestEditorFn) (*GetServiceLevelRuleResponse, error)
GetServiceLevelRuleWithResponse request returning *GetServiceLevelRuleResponse
func (*ClientWithResponses) GetServiceLevelRulesetWithResponse ¶
func (c *ClientWithResponses) GetServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, params *GetServiceLevelRulesetParams, reqEditors ...RequestEditorFn) (*GetServiceLevelRulesetResponse, error)
GetServiceLevelRulesetWithResponse request returning *GetServiceLevelRulesetResponse
func (*ClientWithResponses) GetShipmentWithResponse ¶
func (c *ClientWithResponses) GetShipmentWithResponse(ctx context.Context, shipmentId string, params *GetShipmentParams, reqEditors ...RequestEditorFn) (*GetShipmentResponse, error)
GetShipmentWithResponse request returning *GetShipmentResponse
func (*ClientWithResponses) GetShippingRatesWithBodyWithResponse ¶
func (c *ClientWithResponses) GetShippingRatesWithBodyWithResponse(ctx context.Context, params *GetShippingRatesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetShippingRatesResponse, error)
GetShippingRatesWithBodyWithResponse request with arbitrary body returning *GetShippingRatesResponse
func (*ClientWithResponses) GetShippingRatesWithResponse ¶
func (c *ClientWithResponses) GetShippingRatesWithResponse(ctx context.Context, params *GetShippingRatesParams, body GetShippingRatesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetShippingRatesResponse, error)
func (*ClientWithResponses) ListAttrbutesWithResponse ¶
func (c *ClientWithResponses) ListAttrbutesWithResponse(ctx context.Context, params *ListAttrbutesParams, reqEditors ...RequestEditorFn) (*ListAttrbutesResponse, error)
ListAttrbutesWithResponse request returning *ListAttrbutesResponse
func (*ClientWithResponses) ListAutomationRulesWithResponse ¶
func (c *ClientWithResponses) ListAutomationRulesWithResponse(ctx context.Context, automationRulesetId string, params *ListAutomationRulesParams, reqEditors ...RequestEditorFn) (*ListAutomationRulesResponse, error)
ListAutomationRulesWithResponse request returning *ListAutomationRulesResponse
func (*ClientWithResponses) ListAutomationRulesetsWithResponse ¶
func (c *ClientWithResponses) ListAutomationRulesetsWithResponse(ctx context.Context, params *ListAutomationRulesetsParams, reqEditors ...RequestEditorFn) (*ListAutomationRulesetsResponse, error)
ListAutomationRulesetsWithResponse request returning *ListAutomationRulesetsResponse
func (*ClientWithResponses) ListCarrierAccountsWithResponse ¶
func (c *ClientWithResponses) ListCarrierAccountsWithResponse(ctx context.Context, params *ListCarrierAccountsParams, reqEditors ...RequestEditorFn) (*ListCarrierAccountsResponse, error)
ListCarrierAccountsWithResponse request returning *ListCarrierAccountsResponse
func (*ClientWithResponses) ListManifestsWithResponse ¶
func (c *ClientWithResponses) ListManifestsWithResponse(ctx context.Context, params *ListManifestsParams, reqEditors ...RequestEditorFn) (*ListManifestsResponse, error)
ListManifestsWithResponse request returning *ListManifestsResponse
func (*ClientWithResponses) ListServiceLevelRulesWithResponse ¶
func (c *ClientWithResponses) ListServiceLevelRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, params *ListServiceLevelRulesParams, reqEditors ...RequestEditorFn) (*ListServiceLevelRulesResponse, error)
ListServiceLevelRulesWithResponse request returning *ListServiceLevelRulesResponse
func (*ClientWithResponses) ListServiceLevelRulesetsWithResponse ¶
func (c *ClientWithResponses) ListServiceLevelRulesetsWithResponse(ctx context.Context, params *ListServiceLevelRulesetsParams, reqEditors ...RequestEditorFn) (*ListServiceLevelRulesetsResponse, error)
ListServiceLevelRulesetsWithResponse request returning *ListServiceLevelRulesetsResponse
func (*ClientWithResponses) ListShipmentsWithResponse ¶
func (c *ClientWithResponses) ListShipmentsWithResponse(ctx context.Context, params *ListShipmentsParams, reqEditors ...RequestEditorFn) (*ListShipmentsResponse, error)
ListShipmentsWithResponse request returning *ListShipmentsResponse
func (*ClientWithResponses) PatchAutomationRulesetWithBodyWithResponse ¶
func (c *ClientWithResponses) PatchAutomationRulesetWithBodyWithResponse(ctx context.Context, automationRulesetId string, params *PatchAutomationRulesetParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchAutomationRulesetResponse, error)
PatchAutomationRulesetWithBodyWithResponse request with arbitrary body returning *PatchAutomationRulesetResponse
func (*ClientWithResponses) PatchAutomationRulesetWithResponse ¶
func (c *ClientWithResponses) PatchAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, params *PatchAutomationRulesetParams, body PatchAutomationRulesetJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchAutomationRulesetResponse, error)
func (*ClientWithResponses) PatchServiceLevelRulesetWithBodyWithResponse ¶
func (c *ClientWithResponses) PatchServiceLevelRulesetWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchServiceLevelRulesetResponse, error)
PatchServiceLevelRulesetWithBodyWithResponse request with arbitrary body returning *PatchServiceLevelRulesetResponse
func (*ClientWithResponses) PatchServiceLevelRulesetWithResponse ¶
func (c *ClientWithResponses) PatchServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, body PatchServiceLevelRulesetJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchServiceLevelRulesetResponse, error)
func (*ClientWithResponses) ReadyToShipWithBodyWithResponse ¶
func (c *ClientWithResponses) ReadyToShipWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReadyToShipParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReadyToShipResponse, error)
ReadyToShipWithBodyWithResponse request with arbitrary body returning *ReadyToShipResponse
func (*ClientWithResponses) ReadyToShipWithResponse ¶
func (c *ClientWithResponses) ReadyToShipWithResponse(ctx context.Context, shipmentId string, params *ReadyToShipParams, body ReadyToShipJSONRequestBody, reqEditors ...RequestEditorFn) (*ReadyToShipResponse, error)
func (*ClientWithResponses) ReassignShipmentWithBodyWithResponse ¶
func (c *ClientWithResponses) ReassignShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReassignShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReassignShipmentResponse, error)
ReassignShipmentWithBodyWithResponse request with arbitrary body returning *ReassignShipmentResponse
func (*ClientWithResponses) ReassignShipmentWithResponse ¶
func (c *ClientWithResponses) ReassignShipmentWithResponse(ctx context.Context, shipmentId string, params *ReassignShipmentParams, body ReassignShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*ReassignShipmentResponse, error)
func (*ClientWithResponses) RefreshLabelWithResponse ¶
func (c *ClientWithResponses) RefreshLabelWithResponse(ctx context.Context, shipmentId string, params *RefreshLabelParams, reqEditors ...RequestEditorFn) (*RefreshLabelResponse, error)
RefreshLabelWithResponse request returning *RefreshLabelResponse
func (*ClientWithResponses) ReprocessShipmentWithBodyWithResponse ¶
func (c *ClientWithResponses) ReprocessShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReprocessShipmentResponse, error)
ReprocessShipmentWithBodyWithResponse request with arbitrary body returning *ReprocessShipmentResponse
func (*ClientWithResponses) ReprocessShipmentWithResponse ¶
func (c *ClientWithResponses) ReprocessShipmentWithResponse(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, body ReprocessShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*ReprocessShipmentResponse, error)
func (*ClientWithResponses) RetryManifestWithResponse ¶
func (c *ClientWithResponses) RetryManifestWithResponse(ctx context.Context, manifestId string, params *RetryManifestParams, reqEditors ...RequestEditorFn) (*RetryManifestResponse, error)
RetryManifestWithResponse request returning *RetryManifestResponse
func (*ClientWithResponses) ShipManifestWithResponse ¶
func (c *ClientWithResponses) ShipManifestWithResponse(ctx context.Context, manifestId string, params *ShipManifestParams, reqEditors ...RequestEditorFn) (*ShipManifestResponse, error)
ShipManifestWithResponse request returning *ShipManifestResponse
func (*ClientWithResponses) UpdateAttributeWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateAttributeWithBodyWithResponse(ctx context.Context, attributeId string, params *UpdateAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAttributeResponse, error)
UpdateAttributeWithBodyWithResponse request with arbitrary body returning *UpdateAttributeResponse
func (*ClientWithResponses) UpdateAttributeWithResponse ¶
func (c *ClientWithResponses) UpdateAttributeWithResponse(ctx context.Context, attributeId string, params *UpdateAttributeParams, body UpdateAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAttributeResponse, error)
func (*ClientWithResponses) UpdateAutomationRuleWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateAutomationRuleWithBodyWithResponse(ctx context.Context, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutomationRuleResponse, error)
UpdateAutomationRuleWithBodyWithResponse request with arbitrary body returning *UpdateAutomationRuleResponse
func (*ClientWithResponses) UpdateAutomationRuleWithResponse ¶
func (c *ClientWithResponses) UpdateAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, body UpdateAutomationRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutomationRuleResponse, error)
func (*ClientWithResponses) UpdateAutomationRulesSequenceWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateAutomationRulesSequenceWithBodyWithResponse(ctx context.Context, rulesetId string, params *UpdateAutomationRulesSequenceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutomationRulesSequenceResponse, error)
UpdateAutomationRulesSequenceWithBodyWithResponse request with arbitrary body returning *UpdateAutomationRulesSequenceResponse
func (*ClientWithResponses) UpdateAutomationRulesSequenceWithResponse ¶
func (c *ClientWithResponses) UpdateAutomationRulesSequenceWithResponse(ctx context.Context, rulesetId string, params *UpdateAutomationRulesSequenceParams, body UpdateAutomationRulesSequenceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutomationRulesSequenceResponse, error)
func (*ClientWithResponses) UpdateAutomationRulesetAndRulesWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateAutomationRulesetAndRulesWithBodyWithResponse(ctx context.Context, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutomationRulesetAndRulesResponse, error)
UpdateAutomationRulesetAndRulesWithBodyWithResponse request with arbitrary body returning *UpdateAutomationRulesetAndRulesResponse
func (*ClientWithResponses) UpdateAutomationRulesetAndRulesWithResponse ¶
func (c *ClientWithResponses) UpdateAutomationRulesetAndRulesWithResponse(ctx context.Context, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, body UpdateAutomationRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutomationRulesetAndRulesResponse, error)
func (*ClientWithResponses) UpdateCarrierAccountWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateCarrierAccountWithBodyWithResponse(ctx context.Context, carrierAccountId string, params *UpdateCarrierAccountParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCarrierAccountResponse, error)
UpdateCarrierAccountWithBodyWithResponse request with arbitrary body returning *UpdateCarrierAccountResponse
func (*ClientWithResponses) UpdateCarrierAccountWithResponse ¶
func (c *ClientWithResponses) UpdateCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, params *UpdateCarrierAccountParams, body UpdateCarrierAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCarrierAccountResponse, error)
func (*ClientWithResponses) UpdateCollectionScheduleWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateCollectionScheduleWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCollectionScheduleResponse, error)
UpdateCollectionScheduleWithBodyWithResponse request with arbitrary body returning *UpdateCollectionScheduleResponse
func (*ClientWithResponses) UpdateCollectionScheduleWithResponse ¶
func (c *ClientWithResponses) UpdateCollectionScheduleWithResponse(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, body UpdateCollectionScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCollectionScheduleResponse, error)
func (*ClientWithResponses) UpdateDeliveryPromiseWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateDeliveryPromiseWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDeliveryPromiseResponse, error)
UpdateDeliveryPromiseWithBodyWithResponse request with arbitrary body returning *UpdateDeliveryPromiseResponse
func (*ClientWithResponses) UpdateDeliveryPromiseWithResponse ¶
func (c *ClientWithResponses) UpdateDeliveryPromiseWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, body UpdateDeliveryPromiseJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDeliveryPromiseResponse, error)
func (*ClientWithResponses) UpdateDeliveryScheduleWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateDeliveryScheduleWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDeliveryScheduleResponse, error)
UpdateDeliveryScheduleWithBodyWithResponse request with arbitrary body returning *UpdateDeliveryScheduleResponse
func (*ClientWithResponses) UpdateDeliveryScheduleWithResponse ¶
func (c *ClientWithResponses) UpdateDeliveryScheduleWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, body UpdateDeliveryScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDeliveryScheduleResponse, error)
func (*ClientWithResponses) UpdateParcelsWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateParcelsWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateParcelsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateParcelsResponse, error)
UpdateParcelsWithBodyWithResponse request with arbitrary body returning *UpdateParcelsResponse
func (*ClientWithResponses) UpdateParcelsWithResponse ¶
func (c *ClientWithResponses) UpdateParcelsWithResponse(ctx context.Context, shipmentId string, params *UpdateParcelsParams, body UpdateParcelsJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateParcelsResponse, error)
func (*ClientWithResponses) UpdateServiceLevelRuleWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateServiceLevelRuleWithBodyWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRuleResponse, error)
UpdateServiceLevelRuleWithBodyWithResponse request with arbitrary body returning *UpdateServiceLevelRuleResponse
func (*ClientWithResponses) UpdateServiceLevelRuleWithResponse ¶
func (c *ClientWithResponses) UpdateServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, body UpdateServiceLevelRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRuleResponse, error)
func (*ClientWithResponses) UpdateServiceLevelRulesSequenceWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateServiceLevelRulesSequenceWithBodyWithResponse(ctx context.Context, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRulesSequenceResponse, error)
UpdateServiceLevelRulesSequenceWithBodyWithResponse request with arbitrary body returning *UpdateServiceLevelRulesSequenceResponse
func (*ClientWithResponses) UpdateServiceLevelRulesSequenceWithResponse ¶
func (c *ClientWithResponses) UpdateServiceLevelRulesSequenceWithResponse(ctx context.Context, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, body UpdateServiceLevelRulesSequenceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRulesSequenceResponse, error)
func (*ClientWithResponses) UpdateServiceLevelRulesetAndRulesWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateServiceLevelRulesetAndRulesWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRulesetAndRulesResponse, error)
UpdateServiceLevelRulesetAndRulesWithBodyWithResponse request with arbitrary body returning *UpdateServiceLevelRulesetAndRulesResponse
func (*ClientWithResponses) UpdateServiceLevelRulesetAndRulesWithResponse ¶
func (c *ClientWithResponses) UpdateServiceLevelRulesetAndRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, body UpdateServiceLevelRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRulesetAndRulesResponse, error)
func (*ClientWithResponses) UpdateShipmentPatchWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateShipmentPatchWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateShipmentPatchResponse, error)
UpdateShipmentPatchWithBodyWithResponse request with arbitrary body returning *UpdateShipmentPatchResponse
func (*ClientWithResponses) UpdateShipmentPatchWithResponse ¶
func (c *ClientWithResponses) UpdateShipmentPatchWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, body UpdateShipmentPatchJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateShipmentPatchResponse, error)
func (*ClientWithResponses) UpdateShipmentWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateShipmentResponse, error)
UpdateShipmentWithBodyWithResponse request with arbitrary body returning *UpdateShipmentResponse
func (*ClientWithResponses) UpdateShipmentWithResponse ¶
func (c *ClientWithResponses) UpdateShipmentWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentParams, body UpdateShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateShipmentResponse, error)
func (*ClientWithResponses) UpdateStatusWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateStatusWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateStatusParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStatusResponse, error)
UpdateStatusWithBodyWithResponse request with arbitrary body returning *UpdateStatusResponse
func (*ClientWithResponses) UpdateStatusWithResponse ¶
func (c *ClientWithResponses) UpdateStatusWithResponse(ctx context.Context, shipmentId string, params *UpdateStatusParams, body UpdateStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStatusResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// ListAttrbutesWithResponse request
ListAttrbutesWithResponse(ctx context.Context, params *ListAttrbutesParams, reqEditors ...RequestEditorFn) (*ListAttrbutesResponse, error)
// CreateAttributeWithBodyWithResponse request with any body
CreateAttributeWithBodyWithResponse(ctx context.Context, params *CreateAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAttributeResponse, error)
CreateAttributeWithResponse(ctx context.Context, params *CreateAttributeParams, body CreateAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAttributeResponse, error)
// DeleteAttributeWithResponse request
DeleteAttributeWithResponse(ctx context.Context, attributeId string, params *DeleteAttributeParams, reqEditors ...RequestEditorFn) (*DeleteAttributeResponse, error)
// GetAttributeWithResponse request
GetAttributeWithResponse(ctx context.Context, attributeId string, params *GetAttributeParams, reqEditors ...RequestEditorFn) (*GetAttributeResponse, error)
// UpdateAttributeWithBodyWithResponse request with any body
UpdateAttributeWithBodyWithResponse(ctx context.Context, attributeId string, params *UpdateAttributeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAttributeResponse, error)
UpdateAttributeWithResponse(ctx context.Context, attributeId string, params *UpdateAttributeParams, body UpdateAttributeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAttributeResponse, error)
// ListAutomationRulesetsWithResponse request
ListAutomationRulesetsWithResponse(ctx context.Context, params *ListAutomationRulesetsParams, reqEditors ...RequestEditorFn) (*ListAutomationRulesetsResponse, error)
// CreateAutomationRulesetAndRulesWithBodyWithResponse request with any body
CreateAutomationRulesetAndRulesWithBodyWithResponse(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAutomationRulesetAndRulesResponse, error)
CreateAutomationRulesetAndRulesWithResponse(ctx context.Context, params *CreateAutomationRulesetAndRulesParams, body CreateAutomationRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAutomationRulesetAndRulesResponse, error)
// DeleteAutomationRulesetWithResponse request
DeleteAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, params *DeleteAutomationRulesetParams, reqEditors ...RequestEditorFn) (*DeleteAutomationRulesetResponse, error)
// GetAutomationRulesetWithResponse request
GetAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, params *GetAutomationRulesetParams, reqEditors ...RequestEditorFn) (*GetAutomationRulesetResponse, error)
// PatchAutomationRulesetWithBodyWithResponse request with any body
PatchAutomationRulesetWithBodyWithResponse(ctx context.Context, automationRulesetId string, params *PatchAutomationRulesetParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchAutomationRulesetResponse, error)
PatchAutomationRulesetWithResponse(ctx context.Context, automationRulesetId string, params *PatchAutomationRulesetParams, body PatchAutomationRulesetJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchAutomationRulesetResponse, error)
// UpdateAutomationRulesetAndRulesWithBodyWithResponse request with any body
UpdateAutomationRulesetAndRulesWithBodyWithResponse(ctx context.Context, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutomationRulesetAndRulesResponse, error)
UpdateAutomationRulesetAndRulesWithResponse(ctx context.Context, automationRulesetId string, params *UpdateAutomationRulesetAndRulesParams, body UpdateAutomationRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutomationRulesetAndRulesResponse, error)
// ListAutomationRulesWithResponse request
ListAutomationRulesWithResponse(ctx context.Context, automationRulesetId string, params *ListAutomationRulesParams, reqEditors ...RequestEditorFn) (*ListAutomationRulesResponse, error)
// CreateAutomationRulesWithBodyWithResponse request with any body
CreateAutomationRulesWithBodyWithResponse(ctx context.Context, automationRulesetId string, params *CreateAutomationRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAutomationRulesResponse, error)
CreateAutomationRulesWithResponse(ctx context.Context, automationRulesetId string, params *CreateAutomationRulesParams, body CreateAutomationRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAutomationRulesResponse, error)
// UpdateAutomationRulesSequenceWithBodyWithResponse request with any body
UpdateAutomationRulesSequenceWithBodyWithResponse(ctx context.Context, rulesetId string, params *UpdateAutomationRulesSequenceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutomationRulesSequenceResponse, error)
UpdateAutomationRulesSequenceWithResponse(ctx context.Context, rulesetId string, params *UpdateAutomationRulesSequenceParams, body UpdateAutomationRulesSequenceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutomationRulesSequenceResponse, error)
// DeleteAutomationRuleWithResponse request
DeleteAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, params *DeleteAutomationRuleParams, reqEditors ...RequestEditorFn) (*DeleteAutomationRuleResponse, error)
// GetAutomationRuleWithResponse request
GetAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, params *GetAutomationRuleParams, reqEditors ...RequestEditorFn) (*GetAutomationRuleResponse, error)
// UpdateAutomationRuleWithBodyWithResponse request with any body
UpdateAutomationRuleWithBodyWithResponse(ctx context.Context, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutomationRuleResponse, error)
UpdateAutomationRuleWithResponse(ctx context.Context, rulesetId string, automationRuleId string, params *UpdateAutomationRuleParams, body UpdateAutomationRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutomationRuleResponse, error)
// ListCarrierAccountsWithResponse request
ListCarrierAccountsWithResponse(ctx context.Context, params *ListCarrierAccountsParams, reqEditors ...RequestEditorFn) (*ListCarrierAccountsResponse, error)
// CreateCarrierAccountWithBodyWithResponse request with any body
CreateCarrierAccountWithBodyWithResponse(ctx context.Context, params *CreateCarrierAccountParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCarrierAccountResponse, error)
CreateCarrierAccountWithResponse(ctx context.Context, params *CreateCarrierAccountParams, body CreateCarrierAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCarrierAccountResponse, error)
// DeleteCarrierAccountWithResponse request
DeleteCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, params *DeleteCarrierAccountParams, reqEditors ...RequestEditorFn) (*DeleteCarrierAccountResponse, error)
// GetCarrierAccountWithResponse request
GetCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, params *GetCarrierAccountParams, reqEditors ...RequestEditorFn) (*GetCarrierAccountResponse, error)
// UpdateCarrierAccountWithBodyWithResponse request with any body
UpdateCarrierAccountWithBodyWithResponse(ctx context.Context, carrierAccountId string, params *UpdateCarrierAccountParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCarrierAccountResponse, error)
UpdateCarrierAccountWithResponse(ctx context.Context, carrierAccountId string, params *UpdateCarrierAccountParams, body UpdateCarrierAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCarrierAccountResponse, error)
// GetShippingRatesWithBodyWithResponse request with any body
GetShippingRatesWithBodyWithResponse(ctx context.Context, params *GetShippingRatesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetShippingRatesResponse, error)
GetShippingRatesWithResponse(ctx context.Context, params *GetShippingRatesParams, body GetShippingRatesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetShippingRatesResponse, error)
// ListManifestsWithResponse request
ListManifestsWithResponse(ctx context.Context, params *ListManifestsParams, reqEditors ...RequestEditorFn) (*ListManifestsResponse, error)
// CreateManifestWithBodyWithResponse request with any body
CreateManifestWithBodyWithResponse(ctx context.Context, params *CreateManifestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateManifestResponse, error)
CreateManifestWithResponse(ctx context.Context, params *CreateManifestParams, body CreateManifestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateManifestResponse, error)
// DeleteManifestWithResponse request
DeleteManifestWithResponse(ctx context.Context, manifestId string, params *DeleteManifestParams, reqEditors ...RequestEditorFn) (*DeleteManifestResponse, error)
// GetManifestWithResponse request
GetManifestWithResponse(ctx context.Context, manifestId string, params *GetManifestParams, reqEditors ...RequestEditorFn) (*GetManifestResponse, error)
// CancelManifestWithResponse request
CancelManifestWithResponse(ctx context.Context, manifestId string, params *CancelManifestParams, reqEditors ...RequestEditorFn) (*CancelManifestResponse, error)
// RetryManifestWithResponse request
RetryManifestWithResponse(ctx context.Context, manifestId string, params *RetryManifestParams, reqEditors ...RequestEditorFn) (*RetryManifestResponse, error)
// ShipManifestWithResponse request
ShipManifestWithResponse(ctx context.Context, manifestId string, params *ShipManifestParams, reqEditors ...RequestEditorFn) (*ShipManifestResponse, error)
// GetAccessTokenWithBodyWithResponse request with any body
GetAccessTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetAccessTokenResponse, error)
GetAccessTokenWithResponse(ctx context.Context, body GetAccessTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*GetAccessTokenResponse, error)
// ListServiceLevelRulesetsWithResponse request
ListServiceLevelRulesetsWithResponse(ctx context.Context, params *ListServiceLevelRulesetsParams, reqEditors ...RequestEditorFn) (*ListServiceLevelRulesetsResponse, error)
// CreateServiceLevelRulesetAndRulesWithBodyWithResponse request with any body
CreateServiceLevelRulesetAndRulesWithBodyWithResponse(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServiceLevelRulesetAndRulesResponse, error)
CreateServiceLevelRulesetAndRulesWithResponse(ctx context.Context, params *CreateServiceLevelRulesetAndRulesParams, body CreateServiceLevelRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServiceLevelRulesetAndRulesResponse, error)
// UpdateServiceLevelRulesSequenceWithBodyWithResponse request with any body
UpdateServiceLevelRulesSequenceWithBodyWithResponse(ctx context.Context, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRulesSequenceResponse, error)
UpdateServiceLevelRulesSequenceWithResponse(ctx context.Context, rulesetId string, params *UpdateServiceLevelRulesSequenceParams, body UpdateServiceLevelRulesSequenceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRulesSequenceResponse, error)
// DeleteServiceLevelRuleWithResponse request
DeleteServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *DeleteServiceLevelRuleParams, reqEditors ...RequestEditorFn) (*DeleteServiceLevelRuleResponse, error)
// GetServiceLevelRuleWithResponse request
GetServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *GetServiceLevelRuleParams, reqEditors ...RequestEditorFn) (*GetServiceLevelRuleResponse, error)
// UpdateServiceLevelRuleWithBodyWithResponse request with any body
UpdateServiceLevelRuleWithBodyWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRuleResponse, error)
UpdateServiceLevelRuleWithResponse(ctx context.Context, rulesetId string, serviceLevelRuleId string, params *UpdateServiceLevelRuleParams, body UpdateServiceLevelRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRuleResponse, error)
// DeleteServiceLevelRulesetWithResponse request
DeleteServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, params *DeleteServiceLevelRulesetParams, reqEditors ...RequestEditorFn) (*DeleteServiceLevelRulesetResponse, error)
// GetServiceLevelRulesetWithResponse request
GetServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, params *GetServiceLevelRulesetParams, reqEditors ...RequestEditorFn) (*GetServiceLevelRulesetResponse, error)
// PatchServiceLevelRulesetWithBodyWithResponse request with any body
PatchServiceLevelRulesetWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchServiceLevelRulesetResponse, error)
PatchServiceLevelRulesetWithResponse(ctx context.Context, serviceLevelRulesetId string, params *PatchServiceLevelRulesetParams, body PatchServiceLevelRulesetJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchServiceLevelRulesetResponse, error)
// UpdateServiceLevelRulesetAndRulesWithBodyWithResponse request with any body
UpdateServiceLevelRulesetAndRulesWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRulesetAndRulesResponse, error)
UpdateServiceLevelRulesetAndRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, params *UpdateServiceLevelRulesetAndRulesParams, body UpdateServiceLevelRulesetAndRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateServiceLevelRulesetAndRulesResponse, error)
// ListServiceLevelRulesWithResponse request
ListServiceLevelRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, params *ListServiceLevelRulesParams, reqEditors ...RequestEditorFn) (*ListServiceLevelRulesResponse, error)
// CreateServiceLevelRulesWithBodyWithResponse request with any body
CreateServiceLevelRulesWithBodyWithResponse(ctx context.Context, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServiceLevelRulesResponse, error)
CreateServiceLevelRulesWithResponse(ctx context.Context, serviceLevelRulesetId string, params *CreateServiceLevelRulesParams, body CreateServiceLevelRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServiceLevelRulesResponse, error)
// ListShipmentsWithResponse request
ListShipmentsWithResponse(ctx context.Context, params *ListShipmentsParams, reqEditors ...RequestEditorFn) (*ListShipmentsResponse, error)
// CreateShipmentWithBodyWithResponse request with any body
CreateShipmentWithBodyWithResponse(ctx context.Context, params *CreateShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateShipmentResponse, error)
CreateShipmentWithResponse(ctx context.Context, params *CreateShipmentParams, body CreateShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateShipmentResponse, error)
// GetBulkStatusWithResponse request
GetBulkStatusWithResponse(ctx context.Context, params *GetBulkStatusParams, reqEditors ...RequestEditorFn) (*GetBulkStatusResponse, error)
// GetShipmentWithResponse request
GetShipmentWithResponse(ctx context.Context, shipmentId string, params *GetShipmentParams, reqEditors ...RequestEditorFn) (*GetShipmentResponse, error)
// UpdateShipmentPatchWithBodyWithResponse request with any body
UpdateShipmentPatchWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateShipmentPatchResponse, error)
UpdateShipmentPatchWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentPatchParams, body UpdateShipmentPatchJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateShipmentPatchResponse, error)
// UpdateShipmentWithBodyWithResponse request with any body
UpdateShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateShipmentResponse, error)
UpdateShipmentWithResponse(ctx context.Context, shipmentId string, params *UpdateShipmentParams, body UpdateShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateShipmentResponse, error)
// CancelShipmentWithBodyWithResponse request with any body
CancelShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CancelShipmentResponse, error)
CancelShipmentWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams, body CancelShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*CancelShipmentResponse, error)
// ConfirmShipmentWithBodyWithResponse request with any body
ConfirmShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConfirmShipmentResponse, error)
ConfirmShipmentWithResponse(ctx context.Context, shipmentId string, params *ConfirmShipmentParams, body ConfirmShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*ConfirmShipmentResponse, error)
// EstimateShippingCostForShipmentWithResponse request
EstimateShippingCostForShipmentWithResponse(ctx context.Context, shipmentId string, params *EstimateShippingCostForShipmentParams, reqEditors ...RequestEditorFn) (*EstimateShippingCostForShipmentResponse, error)
// RefreshLabelWithResponse request
RefreshLabelWithResponse(ctx context.Context, shipmentId string, params *RefreshLabelParams, reqEditors ...RequestEditorFn) (*RefreshLabelResponse, error)
// UpdateParcelsWithBodyWithResponse request with any body
UpdateParcelsWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateParcelsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateParcelsResponse, error)
UpdateParcelsWithResponse(ctx context.Context, shipmentId string, params *UpdateParcelsParams, body UpdateParcelsJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateParcelsResponse, error)
// ReadyToShipWithBodyWithResponse request with any body
ReadyToShipWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReadyToShipParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReadyToShipResponse, error)
ReadyToShipWithResponse(ctx context.Context, shipmentId string, params *ReadyToShipParams, body ReadyToShipJSONRequestBody, reqEditors ...RequestEditorFn) (*ReadyToShipResponse, error)
// ReassignShipmentWithBodyWithResponse request with any body
ReassignShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReassignShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReassignShipmentResponse, error)
ReassignShipmentWithResponse(ctx context.Context, shipmentId string, params *ReassignShipmentParams, body ReassignShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*ReassignShipmentResponse, error)
// ReprocessShipmentWithBodyWithResponse request with any body
ReprocessShipmentWithBodyWithResponse(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReprocessShipmentResponse, error)
ReprocessShipmentWithResponse(ctx context.Context, shipmentId string, params *ReprocessShipmentParams, body ReprocessShipmentJSONRequestBody, reqEditors ...RequestEditorFn) (*ReprocessShipmentResponse, error)
// UpdateCollectionScheduleWithBodyWithResponse request with any body
UpdateCollectionScheduleWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCollectionScheduleResponse, error)
UpdateCollectionScheduleWithResponse(ctx context.Context, shipmentId string, params *UpdateCollectionScheduleParams, body UpdateCollectionScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCollectionScheduleResponse, error)
// UpdateDeliveryPromiseWithBodyWithResponse request with any body
UpdateDeliveryPromiseWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDeliveryPromiseResponse, error)
UpdateDeliveryPromiseWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryPromiseParams, body UpdateDeliveryPromiseJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDeliveryPromiseResponse, error)
// UpdateDeliveryScheduleWithBodyWithResponse request with any body
UpdateDeliveryScheduleWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDeliveryScheduleResponse, error)
UpdateDeliveryScheduleWithResponse(ctx context.Context, shipmentId string, params *UpdateDeliveryScheduleParams, body UpdateDeliveryScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDeliveryScheduleResponse, error)
// UpdateStatusWithBodyWithResponse request with any body
UpdateStatusWithBodyWithResponse(ctx context.Context, shipmentId string, params *UpdateStatusParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStatusResponse, error)
UpdateStatusWithResponse(ctx context.Context, shipmentId string, params *UpdateStatusParams, body UpdateStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStatusResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CollectionObject ¶
type CollectionObject struct {
// ScheduledDate Scheduled date for collection provided by the merchant, represented using only the date part of the ISO 8601 format.
ScheduledDate *openapi_types.Date `json:"scheduled_date,omitempty"`
// ScheduledFrom Start datetime for collection provided by the merchant, represented using both the date and time the ISO 8601 format.
ScheduledFrom *time.Time `json:"scheduled_from,omitempty"`
// ScheduledTo End datetime for collection provided by the merchant, represented using both the date and time the ISO 8601 format.
ScheduledTo *time.Time `json:"scheduled_to,omitempty"`
}
CollectionObject Collection details chosen for the shipment, such as scheduled collection date.
type CollectionRequest ¶
type CollectionRequest struct {
// ScheduledDate Scheduled date for delivery provided by the merchant, represented using only the date part of the ISO 8601 format.
ScheduledDate *openapi_types.Date `json:"scheduled_date,omitempty"`
// ScheduledFrom Start datetime for delivery provided by the merchant, represented using both the date and time the ISO 8601 format.
ScheduledFrom *time.Time `json:"scheduled_from,omitempty"`
// ScheduledTo End datetime for delivery provided by the merchant, represented using both the date and time the ISO 8601 format.
ScheduledTo *time.Time `json:"scheduled_to,omitempty"`
}
CollectionRequest Collection details chosen for the shipment, such as scheduled collection date.
It can be set using one of the following options ¶
Option 1: Provide the `scheduled_from` and `scheduled_to` to choose the scheduled date along with start and end time.
Example:
"collection": {
"scheduled_from": "2022-01-01'T'10:00:00.000+1:00",
"scheduled_to": "2022-01-01'T'12:00:00.000+1:00"
}
Option 2: Provide the `scheduled_date` only to choose the entire day.
Example:
"collection": {
"scheduled_date": "2022-01-01"
}
type ConfirmShipmentJSONRequestBody ¶
type ConfirmShipmentJSONRequestBody = ShipmentPatchRequest
ConfirmShipmentJSONRequestBody defines body for ConfirmShipment for application/json ContentType.
type ConfirmShipmentParams ¶
type ConfirmShipmentParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
ConfirmShipmentParams defines parameters for ConfirmShipment.
type ConfirmShipmentResponse ¶
type ConfirmShipmentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
JSON400 *struct {
Errors []string `json:"errors"`
Status string `json:"status"`
Timestamp string `json:"timestamp"`
}
}
func ParseConfirmShipmentResponse ¶
func ParseConfirmShipmentResponse(rsp *http.Response) (*ConfirmShipmentResponse, error)
ParseConfirmShipmentResponse parses an HTTP response from a ConfirmShipmentWithResponse call
func (ConfirmShipmentResponse) Status ¶
func (r ConfirmShipmentResponse) Status() string
Status returns HTTPResponse.Status
func (ConfirmShipmentResponse) StatusCode ¶
func (r ConfirmShipmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateAttributeJSONRequestBody ¶
type CreateAttributeJSONRequestBody = AttributeRequest
CreateAttributeJSONRequestBody defines body for CreateAttribute for application/json ContentType.
type CreateAttributeParams ¶
type CreateAttributeParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CreateAttributeParams defines parameters for CreateAttribute.
type CreateAttributeResponse ¶
type CreateAttributeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *AttributeResponse
}
func ParseCreateAttributeResponse ¶
func ParseCreateAttributeResponse(rsp *http.Response) (*CreateAttributeResponse, error)
ParseCreateAttributeResponse parses an HTTP response from a CreateAttributeWithResponse call
func (CreateAttributeResponse) Status ¶
func (r CreateAttributeResponse) Status() string
Status returns HTTPResponse.Status
func (CreateAttributeResponse) StatusCode ¶
func (r CreateAttributeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateAutomationRulesJSONRequestBody ¶
type CreateAutomationRulesJSONRequestBody = AutomationRuleRequest
CreateAutomationRulesJSONRequestBody defines body for CreateAutomationRules for application/json ContentType.
type CreateAutomationRulesParams ¶
type CreateAutomationRulesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CreateAutomationRulesParams defines parameters for CreateAutomationRules.
type CreateAutomationRulesResponse ¶
type CreateAutomationRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AutomationRuleResponse
}
func ParseCreateAutomationRulesResponse ¶
func ParseCreateAutomationRulesResponse(rsp *http.Response) (*CreateAutomationRulesResponse, error)
ParseCreateAutomationRulesResponse parses an HTTP response from a CreateAutomationRulesWithResponse call
func (CreateAutomationRulesResponse) Status ¶
func (r CreateAutomationRulesResponse) Status() string
Status returns HTTPResponse.Status
func (CreateAutomationRulesResponse) StatusCode ¶
func (r CreateAutomationRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateAutomationRulesetAndRulesJSONRequestBody ¶
type CreateAutomationRulesetAndRulesJSONRequestBody = AutomationRulesetWithRulesRequest
CreateAutomationRulesetAndRulesJSONRequestBody defines body for CreateAutomationRulesetAndRules for application/json ContentType.
type CreateAutomationRulesetAndRulesParams ¶
type CreateAutomationRulesetAndRulesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CreateAutomationRulesetAndRulesParams defines parameters for CreateAutomationRulesetAndRules.
type CreateAutomationRulesetAndRulesResponse ¶
type CreateAutomationRulesetAndRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AutomationRulesetWithRulesResponse
}
func ParseCreateAutomationRulesetAndRulesResponse ¶
func ParseCreateAutomationRulesetAndRulesResponse(rsp *http.Response) (*CreateAutomationRulesetAndRulesResponse, error)
ParseCreateAutomationRulesetAndRulesResponse parses an HTTP response from a CreateAutomationRulesetAndRulesWithResponse call
func (CreateAutomationRulesetAndRulesResponse) Status ¶
func (r CreateAutomationRulesetAndRulesResponse) Status() string
Status returns HTTPResponse.Status
func (CreateAutomationRulesetAndRulesResponse) StatusCode ¶
func (r CreateAutomationRulesetAndRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateCarrierAccountJSONRequestBody ¶
type CreateCarrierAccountJSONRequestBody = CarrierAccountEndpointRequest
CreateCarrierAccountJSONRequestBody defines body for CreateCarrierAccount for application/json ContentType.
type CreateCarrierAccountParams ¶
type CreateCarrierAccountParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CreateCarrierAccountParams defines parameters for CreateCarrierAccount.
type CreateCarrierAccountResponse ¶
type CreateCarrierAccountResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *CarrierAccountEndpointObject
}
func ParseCreateCarrierAccountResponse ¶
func ParseCreateCarrierAccountResponse(rsp *http.Response) (*CreateCarrierAccountResponse, error)
ParseCreateCarrierAccountResponse parses an HTTP response from a CreateCarrierAccountWithResponse call
func (CreateCarrierAccountResponse) Status ¶
func (r CreateCarrierAccountResponse) Status() string
Status returns HTTPResponse.Status
func (CreateCarrierAccountResponse) StatusCode ¶
func (r CreateCarrierAccountResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateManifestJSONRequestBody ¶
type CreateManifestJSONRequestBody = ManifestRequest
CreateManifestJSONRequestBody defines body for CreateManifest for application/json ContentType.
type CreateManifestParams ¶
type CreateManifestParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CreateManifestParams defines parameters for CreateManifest.
type CreateManifestResponse ¶
type CreateManifestResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *ManifestResponse
}
func ParseCreateManifestResponse ¶
func ParseCreateManifestResponse(rsp *http.Response) (*CreateManifestResponse, error)
ParseCreateManifestResponse parses an HTTP response from a CreateManifestWithResponse call
func (CreateManifestResponse) Status ¶
func (r CreateManifestResponse) Status() string
Status returns HTTPResponse.Status
func (CreateManifestResponse) StatusCode ¶
func (r CreateManifestResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateServiceLevelRulesJSONRequestBody ¶
type CreateServiceLevelRulesJSONRequestBody = ServiceLevelRuleRequest
CreateServiceLevelRulesJSONRequestBody defines body for CreateServiceLevelRules for application/json ContentType.
type CreateServiceLevelRulesParams ¶
type CreateServiceLevelRulesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CreateServiceLevelRulesParams defines parameters for CreateServiceLevelRules.
type CreateServiceLevelRulesResponse ¶
type CreateServiceLevelRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ServiceLevelRuleResponse
}
func ParseCreateServiceLevelRulesResponse ¶
func ParseCreateServiceLevelRulesResponse(rsp *http.Response) (*CreateServiceLevelRulesResponse, error)
ParseCreateServiceLevelRulesResponse parses an HTTP response from a CreateServiceLevelRulesWithResponse call
func (CreateServiceLevelRulesResponse) Status ¶
func (r CreateServiceLevelRulesResponse) Status() string
Status returns HTTPResponse.Status
func (CreateServiceLevelRulesResponse) StatusCode ¶
func (r CreateServiceLevelRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateServiceLevelRulesetAndRulesJSONRequestBody ¶
type CreateServiceLevelRulesetAndRulesJSONRequestBody = ServiceLevelRulesetWithRulesRequest
CreateServiceLevelRulesetAndRulesJSONRequestBody defines body for CreateServiceLevelRulesetAndRules for application/json ContentType.
type CreateServiceLevelRulesetAndRulesParams ¶
type CreateServiceLevelRulesetAndRulesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
CreateServiceLevelRulesetAndRulesParams defines parameters for CreateServiceLevelRulesetAndRules.
type CreateServiceLevelRulesetAndRulesResponse ¶
type CreateServiceLevelRulesetAndRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ServiceLevelRulesetWithRulesResponse
}
func ParseCreateServiceLevelRulesetAndRulesResponse ¶
func ParseCreateServiceLevelRulesetAndRulesResponse(rsp *http.Response) (*CreateServiceLevelRulesetAndRulesResponse, error)
ParseCreateServiceLevelRulesetAndRulesResponse parses an HTTP response from a CreateServiceLevelRulesetAndRulesWithResponse call
func (CreateServiceLevelRulesetAndRulesResponse) Status ¶
func (r CreateServiceLevelRulesetAndRulesResponse) Status() string
Status returns HTTPResponse.Status
func (CreateServiceLevelRulesetAndRulesResponse) StatusCode ¶
func (r CreateServiceLevelRulesetAndRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateShipmentErrorResponse ¶
type CreateShipmentErrorResponse struct {
// Errors Array of validation errors
Errors *[]string `json:"errors,omitempty"`
// Status The error status
Status *string `json:"status,omitempty"`
// Timestamp date in format:
// <code>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</code>
Timestamp *string `json:"timestamp,omitempty"`
}
CreateShipmentErrorResponse The error response returned when a shipment creation request is rejected by Carriyo
type CreateShipmentJSONRequestBody ¶
type CreateShipmentJSONRequestBody = ShipmentRequest
CreateShipmentJSONRequestBody defines body for CreateShipment for application/json ContentType.
type CreateShipmentParams ¶
type CreateShipmentParams struct {
// Draft Pass true for draft shipment
Draft *bool `form:"draft,omitempty" json:"draft,omitempty"`
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
CreateShipmentParams defines parameters for CreateShipment.
type CreateShipmentResponse ¶
type CreateShipmentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
JSON400 *CreateShipmentErrorResponse
}
func ParseCreateShipmentResponse ¶
func ParseCreateShipmentResponse(rsp *http.Response) (*CreateShipmentResponse, error)
ParseCreateShipmentResponse parses an HTTP response from a CreateShipmentWithResponse call
func (CreateShipmentResponse) Status ¶
func (r CreateShipmentResponse) Status() string
Status returns HTTPResponse.Status
func (CreateShipmentResponse) StatusCode ¶
func (r CreateShipmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CustomAttributes ¶
CustomAttributes Custom attributes in the form of a map: ``` {"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]} ``` Please Note: You can only use custom attributes if you are subscribed to this feature.
type CustomAttributesConditionField ¶
type CustomAttributesConditionField struct {
Operator *CustomAttributesConditionFieldOperator `json:"operator,omitempty"`
Value *[]struct {
AttributeName *string `json:"attribute_name,omitempty"`
Operation *CustomAttributesConditionFieldValueOperation `json:"operation,omitempty"`
Values *[]string `json:"values,omitempty"`
} `json:"value,omitempty"`
}
CustomAttributesConditionField defines model for custom-attributes-condition-field.
type CustomAttributesConditionFieldOperator ¶
type CustomAttributesConditionFieldOperator string
CustomAttributesConditionFieldOperator defines model for CustomAttributesConditionField.Operator.
const ( CustomAttributesConditionFieldOperatorEXCLUSION CustomAttributesConditionFieldOperator = "EXCLUSION" CustomAttributesConditionFieldOperatorINCLUSION CustomAttributesConditionFieldOperator = "INCLUSION" )
Defines values for CustomAttributesConditionFieldOperator.
type CustomAttributesConditionFieldValueOperation ¶
type CustomAttributesConditionFieldValueOperation string
CustomAttributesConditionFieldValueOperation defines model for CustomAttributesConditionField.Value.Operation.
const (
CONTAINS CustomAttributesConditionFieldValueOperation = "CONTAINS"
)
Defines values for CustomAttributesConditionFieldValueOperation.
type CustomFields ¶
CustomFields Custom address fields in the form of a map: ``` {"field1" : ["value1", "value2"], "field2" : ["value1", "value2"]} ```
type CustomsObject ¶
type CustomsObject struct {
// DeclaredValue The total value of the shipment (optional) to declare for customs. This value is computed from individual item price if this is not passed.
DeclaredValue *struct {
Amount *float32 `json:"amount,omitempty"`
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency *string `json:"currency,omitempty"`
} `json:"declared_value,omitempty"`
}
CustomsObject Customs declaration details such as total declared value.
type DeleteAttributeParams ¶
type DeleteAttributeParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
DeleteAttributeParams defines parameters for DeleteAttribute.
type DeleteAttributeResponse ¶
type DeleteAttributeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AttributeResponse
}
func ParseDeleteAttributeResponse ¶
func ParseDeleteAttributeResponse(rsp *http.Response) (*DeleteAttributeResponse, error)
ParseDeleteAttributeResponse parses an HTTP response from a DeleteAttributeWithResponse call
func (DeleteAttributeResponse) Status ¶
func (r DeleteAttributeResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteAttributeResponse) StatusCode ¶
func (r DeleteAttributeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteAutomationRuleParams ¶
type DeleteAutomationRuleParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
DeleteAutomationRuleParams defines parameters for DeleteAutomationRule.
type DeleteAutomationRuleResponse ¶
type DeleteAutomationRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
}
func ParseDeleteAutomationRuleResponse ¶
func ParseDeleteAutomationRuleResponse(rsp *http.Response) (*DeleteAutomationRuleResponse, error)
ParseDeleteAutomationRuleResponse parses an HTTP response from a DeleteAutomationRuleWithResponse call
func (DeleteAutomationRuleResponse) Status ¶
func (r DeleteAutomationRuleResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteAutomationRuleResponse) StatusCode ¶
func (r DeleteAutomationRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteAutomationRulesetParams ¶
type DeleteAutomationRulesetParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
DeleteAutomationRulesetParams defines parameters for DeleteAutomationRuleset.
type DeleteAutomationRulesetResponse ¶
type DeleteAutomationRulesetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
}
func ParseDeleteAutomationRulesetResponse ¶
func ParseDeleteAutomationRulesetResponse(rsp *http.Response) (*DeleteAutomationRulesetResponse, error)
ParseDeleteAutomationRulesetResponse parses an HTTP response from a DeleteAutomationRulesetWithResponse call
func (DeleteAutomationRulesetResponse) Status ¶
func (r DeleteAutomationRulesetResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteAutomationRulesetResponse) StatusCode ¶
func (r DeleteAutomationRulesetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteCarrierAccountParams ¶
type DeleteCarrierAccountParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
DeleteCarrierAccountParams defines parameters for DeleteCarrierAccount.
type DeleteCarrierAccountResponse ¶
type DeleteCarrierAccountResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CarrierAccountEndpointObject
}
func ParseDeleteCarrierAccountResponse ¶
func ParseDeleteCarrierAccountResponse(rsp *http.Response) (*DeleteCarrierAccountResponse, error)
ParseDeleteCarrierAccountResponse parses an HTTP response from a DeleteCarrierAccountWithResponse call
func (DeleteCarrierAccountResponse) Status ¶
func (r DeleteCarrierAccountResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteCarrierAccountResponse) StatusCode ¶
func (r DeleteCarrierAccountResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteManifestParams ¶
type DeleteManifestParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
DeleteManifestParams defines parameters for DeleteManifest.
type DeleteManifestResponse ¶
type DeleteManifestResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ManifestResponse
}
func ParseDeleteManifestResponse ¶
func ParseDeleteManifestResponse(rsp *http.Response) (*DeleteManifestResponse, error)
ParseDeleteManifestResponse parses an HTTP response from a DeleteManifestWithResponse call
func (DeleteManifestResponse) Status ¶
func (r DeleteManifestResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteManifestResponse) StatusCode ¶
func (r DeleteManifestResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteServiceLevelRuleParams ¶
type DeleteServiceLevelRuleParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
DeleteServiceLevelRuleParams defines parameters for DeleteServiceLevelRule.
type DeleteServiceLevelRuleResponse ¶
type DeleteServiceLevelRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
}
func ParseDeleteServiceLevelRuleResponse ¶
func ParseDeleteServiceLevelRuleResponse(rsp *http.Response) (*DeleteServiceLevelRuleResponse, error)
ParseDeleteServiceLevelRuleResponse parses an HTTP response from a DeleteServiceLevelRuleWithResponse call
func (DeleteServiceLevelRuleResponse) Status ¶
func (r DeleteServiceLevelRuleResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteServiceLevelRuleResponse) StatusCode ¶
func (r DeleteServiceLevelRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteServiceLevelRulesetParams ¶
type DeleteServiceLevelRulesetParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
DeleteServiceLevelRulesetParams defines parameters for DeleteServiceLevelRuleset.
type DeleteServiceLevelRulesetResponse ¶
type DeleteServiceLevelRulesetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
}
func ParseDeleteServiceLevelRulesetResponse ¶
func ParseDeleteServiceLevelRulesetResponse(rsp *http.Response) (*DeleteServiceLevelRulesetResponse, error)
ParseDeleteServiceLevelRulesetResponse parses an HTTP response from a DeleteServiceLevelRulesetWithResponse call
func (DeleteServiceLevelRulesetResponse) Status ¶
func (r DeleteServiceLevelRulesetResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteServiceLevelRulesetResponse) StatusCode ¶
func (r DeleteServiceLevelRulesetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeliveryObject ¶
type DeliveryObject struct {
// DeliveryType The type of the delivery. The possible values can be one of the delivery types predefined by the merchant.
DeliveryType *string `json:"delivery_type,omitempty"`
// ScheduledDate Scheduled date for delivery provided by the merchant, represented using only the date part of the ISO 8601 format.
ScheduledDate *openapi_types.Date `json:"scheduled_date,omitempty"`
// ScheduledFrom Start datetime for delivery provided by the merchant, represented using both the date and time the ISO 8601 format.
ScheduledFrom *time.Time `json:"scheduled_from,omitempty"`
// ScheduledTo End datetime for delivery provided by the merchant, represented using both the date and time the ISO 8601 format.
ScheduledTo *time.Time `json:"scheduled_to,omitempty"`
}
DeliveryObject Delivery details chosen for the shipment, such as chosen delivery type and scheduled delivery date.
type DeliveryRequest ¶
type DeliveryRequest struct {
// DeliveryType Pass one of the delivery types you have predefined in Carriyo
DeliveryType *string `json:"delivery_type,omitempty"`
// ScheduledDate Pass the Scheduled Date to select an entire day
ScheduledDate *openapi_types.Date `json:"scheduled_date,omitempty"`
// ScheduledFrom Pass the start date-time
ScheduledFrom *time.Time `json:"scheduled_from,omitempty"`
// ScheduledTo Pass the end date-time
ScheduledTo *time.Time `json:"scheduled_to,omitempty"`
}
DeliveryRequest The delivery options chosen for the shipment, including the delivery type and schedule.
It can be set using one of the following options ¶
Option 1: Provide the `scheduled_from` and `scheduled_to` to choose the scheduled date along with start and end time.
Example:
"delivery": {
"delivery_type": "STANDARD",
"scheduled_from": "2022-01-01'T'10:00:00.000+1:00",
"scheduled_to": "2022-01-01'T'12:00:00.000+1:00"
}
Option 2: Provide the `scheduled_date` only to choose the entire day.
Example:
"delivery": {
"delivery_type": "STANDARD",
"scheduled_date": "2022-01-01"
}
type Dimension ¶
type Dimension struct {
Depth *float32 `json:"depth,omitempty"`
Height *float32 `json:"height,omitempty"`
// Unit Default dimension unit is `cm` if not provided.
Unit *DimensionUnit `json:"unit,omitempty"`
Width *float32 `json:"width,omitempty"`
}
Dimension defines model for dimension.
type DimensionUnit ¶
type DimensionUnit string
DimensionUnit Default dimension unit is `cm` if not provided.
const (
Cm DimensionUnit = "cm"
)
Defines values for DimensionUnit.
type DocumentObject ¶
type DocumentObject struct {
// Format Possible Values:
// pdf
Format *string `json:"format,omitempty"`
// Name Document name
Name *string `json:"name,omitempty"`
// Source Possible Values:
// carriyo, carrier
Source *string `json:"source,omitempty"`
// Type Possible Values:
// commercial_invoice, customer_receipt, delivery_advice, gift_message, packing_list
Type *string `json:"type,omitempty"`
// Url The url of document provided by the Carriyo or carrier
Url *string `json:"url,omitempty"`
}
DocumentObject defines model for document-object.
type ErrorDetail ¶
type ErrorDetail struct {
// Code Possible Values:
// required_data_missing, required_data_invalid, merchant_missing, default_merchant_not_configured, phone_number_invalid, email_invalid, email_missing, coordinates_invalid, coordinates_latitude_invalid, coordinates_longitude_invalid, carrier_account_invalid, no_carrier_assigned, partner_location_invalid, time_slot_invalid, status_change_not_allowed, custom_attribute_invalid, custom_attribute_value_invalid, parcel_item_invalid, payment_method_invalid, payment_currency_invalid, country_invalid, postcode_missing, item_origin_country_missing, item_hscode_missing, item_weight_missing, parcel_info_missing, parcel_weight_missing, parcel_dimensions_missing, label_format_invalid, weight_unit_invalid, dimension_unit_invalid, address_field_not_found, template_parsing_failed
Code *string `json:"code,omitempty"`
Field *string `json:"field,omitempty"`
// Level Possible Values: ERROR, WARNING
Level *string `json:"level,omitempty"`
Message *string `json:"message,omitempty"`
// Source Possible Values: CARRIYO, CARRIER
Source *string `json:"source,omitempty"`
// Trigger Possible Values: BOOKING, CANCELLATION, TRACKING, SCHEDULING
Trigger *string `json:"trigger,omitempty"`
// Type Possible Values: VALIDATION, TECHNICAL, UNKNOWN
Type *string `json:"type,omitempty"`
}
ErrorDetail defines model for error-detail.
type EstimateShippingCostForShipmentParams ¶
type EstimateShippingCostForShipmentParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
}
EstimateShippingCostForShipmentParams defines parameters for EstimateShippingCostForShipment.
type EstimateShippingCostForShipmentResponse ¶
type EstimateShippingCostForShipmentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
}
func ParseEstimateShippingCostForShipmentResponse ¶
func ParseEstimateShippingCostForShipmentResponse(rsp *http.Response) (*EstimateShippingCostForShipmentResponse, error)
ParseEstimateShippingCostForShipmentResponse parses an HTTP response from a EstimateShippingCostForShipmentWithResponse call
func (EstimateShippingCostForShipmentResponse) Status ¶
func (r EstimateShippingCostForShipmentResponse) Status() string
Status returns HTTPResponse.Status
func (EstimateShippingCostForShipmentResponse) StatusCode ¶
func (r EstimateShippingCostForShipmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type EstimatedShippingCost ¶
type EstimatedShippingCost struct {
Amount *float32 `json:"amount,omitempty"`
// Breakdown The breakdown of shipping cost.
Breakdown *[]BreakdownObject `json:"breakdown,omitempty"`
Currency *string `json:"currency,omitempty"`
}
EstimatedShippingCost The estimated cost of the shipping based either on the costing profile you have configured for the carrier or carrier costing API response
type FreeFormRequest ¶
type FreeFormRequest struct {
// Address1 Address Line 1 (e.g., street, PO Box, or company name).
Address1 string `json:"address1"`
// Address2 Address Line 2 (e.g., apartment, floor, unit, or building).
Address2 *string `json:"address2,omitempty"`
// AddressCodes Array of location codes for the address
AddressCodes *[]AddressCode `json:"address_codes,omitempty"`
// AlternatePhone Alternate phone number for contact in E164 Format with country code. e.g., +16175551210
AlternatePhone *string `json:"alternate_phone,omitempty"`
// Area District, suburb or neighbourhood, represented by the Carriyo Area Code if known. If not, it's a free text.
//
// Please use the Carriyo standard Area Code when available, to ensure that Carriyo can map this information correctly to the carrier.
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
Area *string `json:"area,omitempty"`
// Building Building number or name
Building *string `json:"building,omitempty"`
// City City, town, or village, represented by the Carriyo City Code if known. If not, it's a free text.
//
// Please use the Carriyo standard City Code when available, to ensure that Carriyo can map this information correctly to the carrier.
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
City string `json:"city"`
// CollectionPointId ID of the carrier's collection point for deliveries held at the carrier location for collection
CollectionPointId *string `json:"collection_point_id,omitempty"`
// ContactEmail Email address for contact
// Conditionally mandatory based on Account Settings
ContactEmail *string `json:"contact_email,omitempty"`
// ContactName Name of the contact person or business
ContactName string `json:"contact_name"`
// ContactPhone Primary phone number for contact in E164 Format with country code. e.g., +16175551212
// Conditionally mandatory based on Account Settings
ContactPhone *string `json:"contact_phone,omitempty"`
// Coords Latitude and longitude (decimal degrees) of the address as an array. e.g., [25.19741, 55.27442]
Coords *[]float32 `json:"coords,omitempty"`
// Country Two-letter country code (ISO 3166-1 alpha-2).
Country string `json:"country"`
// CustomFields Custom address fields in the form of a map:
// “`
// {"field1" : ["value1", "value2"], "field2" : ["value1", "value2"]}
// “`
CustomFields *CustomFields `json:"custom_fields,omitempty"`
// Flat Flat number
Flat *string `json:"flat,omitempty"`
// Floor Floor number
Floor *string `json:"floor,omitempty"`
// LocationCodes Array of location codes for the address
LocationCodes *[]LocationCode `json:"location_codes,omitempty"`
// Notes Any additional notes e.g., "Leave the parcel next to the bin" or "Collect the parcel from the neighbour"
Notes *string `json:"notes,omitempty"`
// PersonalId ID of the person to whom the shipment is addressed
PersonalId *PersonalId `json:"personal_id,omitempty"`
// PoBox Box number if the address is a PO Box
PoBox *string `json:"po_box,omitempty"`
// Postcode ZIP or postal code
Postcode *string `json:"postcode,omitempty"`
// RegistrationNumbers Array of registration numbers for customs/VAT purposes
RegistrationNumbers *[]RegistrationNumber `json:"registration_numbers,omitempty"`
// State State, county, province, or region, represented by the Carriyo State Code if known. If not, it's a free text.
//
// **Note: The state is automatically set if a standard Carriyo city is passed.**
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
State *string `json:"state,omitempty"`
// Street Street number or name
Street *string `json:"street,omitempty"`
// Type Type of address. i.e. business or residential
Type *FreeFormRequestType `json:"type,omitempty"`
What3words *string `json:"what3words,omitempty"`
}
FreeFormRequest Provide the contact and address information
type FreeFormRequestType ¶
type FreeFormRequestType string
FreeFormRequestType Type of address. i.e. business or residential
const ( FreeFormRequestTypeBusiness FreeFormRequestType = "business" FreeFormRequestTypeResidential FreeFormRequestType = "residential" )
Defines values for FreeFormRequestType.
type GeographyConditionField ¶
type GeographyConditionField struct {
Operator *GeographyConditionFieldOperator `json:"operator,omitempty"`
Value *[]struct {
// Country ISO2 country code
Country *string `json:"country,omitempty"`
StateCities *[]struct {
CityAreas *[]struct {
Areas *[]string `json:"areas,omitempty"`
City *string `json:"city,omitempty"`
} `json:"city_areas,omitempty"`
State *string `json:"state,omitempty"`
} `json:"state_cities,omitempty"`
} `json:"value,omitempty"`
}
GeographyConditionField defines model for geography-condition-field.
type GeographyConditionFieldOperator ¶
type GeographyConditionFieldOperator string
GeographyConditionFieldOperator defines model for GeographyConditionField.Operator.
const ( GeographyConditionFieldOperatorEXCLUSION GeographyConditionFieldOperator = "EXCLUSION" GeographyConditionFieldOperatorINCLUSION GeographyConditionFieldOperator = "INCLUSION" )
Defines values for GeographyConditionFieldOperator.
type GetAccessTokenJSONBody ¶ added in v0.3.0
type GetAccessTokenJSONBody struct {
// ClientId The client ID generated in the Carriyo Dashboard
ClientId string `json:"client_id"`
// ClientSecret The client secret generated in the Carriyo Dashboard
ClientSecret string `json:"client_secret"`
}
GetAccessTokenJSONBody defines parameters for GetAccessToken.
type GetAccessTokenJSONRequestBody ¶ added in v0.3.0
type GetAccessTokenJSONRequestBody GetAccessTokenJSONBody
GetAccessTokenJSONRequestBody defines body for GetAccessToken for application/json ContentType.
type GetAccessTokenResponse ¶ added in v0.3.0
type GetAccessTokenResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
// AccessToken The OAuth access token to be used for API calls
AccessToken string `json:"access_token"`
// ExpiresIn Expiry time in seconds
ExpiresIn float32 `json:"expires_in"`
// Scope The permissions granted to the oauth token
Scope string `json:"scope"`
// TokenType Token type - Bearer
TokenType string `json:"token_type"`
}
JSON401 *struct {
// Error The type of error
Error string `json:"error"`
// ErrorDescription The error description
ErrorDescription string `json:"error_description"`
}
}
func ParseGetAccessTokenResponse ¶ added in v0.3.0
func ParseGetAccessTokenResponse(rsp *http.Response) (*GetAccessTokenResponse, error)
ParseGetAccessTokenResponse parses an HTTP response from a GetAccessTokenWithResponse call
func (GetAccessTokenResponse) Status ¶ added in v0.3.0
func (r GetAccessTokenResponse) Status() string
Status returns HTTPResponse.Status
func (GetAccessTokenResponse) StatusCode ¶ added in v0.3.0
func (r GetAccessTokenResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetAttributeParams ¶
type GetAttributeParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
GetAttributeParams defines parameters for GetAttribute.
type GetAttributeResponse ¶
type GetAttributeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AttributeResponse
}
func ParseGetAttributeResponse ¶
func ParseGetAttributeResponse(rsp *http.Response) (*GetAttributeResponse, error)
ParseGetAttributeResponse parses an HTTP response from a GetAttributeWithResponse call
func (GetAttributeResponse) Status ¶
func (r GetAttributeResponse) Status() string
Status returns HTTPResponse.Status
func (GetAttributeResponse) StatusCode ¶
func (r GetAttributeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetAutomationRuleParams ¶
type GetAutomationRuleParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
GetAutomationRuleParams defines parameters for GetAutomationRule.
type GetAutomationRuleResponse ¶
type GetAutomationRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AutomationRuleResponse
}
func ParseGetAutomationRuleResponse ¶
func ParseGetAutomationRuleResponse(rsp *http.Response) (*GetAutomationRuleResponse, error)
ParseGetAutomationRuleResponse parses an HTTP response from a GetAutomationRuleWithResponse call
func (GetAutomationRuleResponse) Status ¶
func (r GetAutomationRuleResponse) Status() string
Status returns HTTPResponse.Status
func (GetAutomationRuleResponse) StatusCode ¶
func (r GetAutomationRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetAutomationRulesetParams ¶
type GetAutomationRulesetParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
GetAutomationRulesetParams defines parameters for GetAutomationRuleset.
type GetAutomationRulesetResponse ¶
type GetAutomationRulesetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RulesetResponse
}
func ParseGetAutomationRulesetResponse ¶
func ParseGetAutomationRulesetResponse(rsp *http.Response) (*GetAutomationRulesetResponse, error)
ParseGetAutomationRulesetResponse parses an HTTP response from a GetAutomationRulesetWithResponse call
func (GetAutomationRulesetResponse) Status ¶
func (r GetAutomationRulesetResponse) Status() string
Status returns HTTPResponse.Status
func (GetAutomationRulesetResponse) StatusCode ¶
func (r GetAutomationRulesetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetBulkStatusParams ¶
type GetBulkStatusParams struct {
ShipmentId *[]string `form:"shipment_id,omitempty" json:"shipment_id,omitempty"`
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
}
GetBulkStatusParams defines parameters for GetBulkStatus.
type GetBulkStatusResponse ¶
type GetBulkStatusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]BulkShipmentStatusResponse
}
func ParseGetBulkStatusResponse ¶
func ParseGetBulkStatusResponse(rsp *http.Response) (*GetBulkStatusResponse, error)
ParseGetBulkStatusResponse parses an HTTP response from a GetBulkStatusWithResponse call
func (GetBulkStatusResponse) Status ¶
func (r GetBulkStatusResponse) Status() string
Status returns HTTPResponse.Status
func (GetBulkStatusResponse) StatusCode ¶
func (r GetBulkStatusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetCarrierAccountParams ¶
type GetCarrierAccountParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
GetCarrierAccountParams defines parameters for GetCarrierAccount.
type GetCarrierAccountResponse ¶
type GetCarrierAccountResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CarrierAccountEndpointObject
}
func ParseGetCarrierAccountResponse ¶
func ParseGetCarrierAccountResponse(rsp *http.Response) (*GetCarrierAccountResponse, error)
ParseGetCarrierAccountResponse parses an HTTP response from a GetCarrierAccountWithResponse call
func (GetCarrierAccountResponse) Status ¶
func (r GetCarrierAccountResponse) Status() string
Status returns HTTPResponse.Status
func (GetCarrierAccountResponse) StatusCode ¶
func (r GetCarrierAccountResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetManifestParams ¶
type GetManifestParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
GetManifestParams defines parameters for GetManifest.
type GetManifestResponse ¶
type GetManifestResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ManifestResponse
}
func ParseGetManifestResponse ¶
func ParseGetManifestResponse(rsp *http.Response) (*GetManifestResponse, error)
ParseGetManifestResponse parses an HTTP response from a GetManifestWithResponse call
func (GetManifestResponse) Status ¶
func (r GetManifestResponse) Status() string
Status returns HTTPResponse.Status
func (GetManifestResponse) StatusCode ¶
func (r GetManifestResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetServiceLevelRuleParams ¶
type GetServiceLevelRuleParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
GetServiceLevelRuleParams defines parameters for GetServiceLevelRule.
type GetServiceLevelRuleResponse ¶
type GetServiceLevelRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ServiceLevelRuleResponse
}
func ParseGetServiceLevelRuleResponse ¶
func ParseGetServiceLevelRuleResponse(rsp *http.Response) (*GetServiceLevelRuleResponse, error)
ParseGetServiceLevelRuleResponse parses an HTTP response from a GetServiceLevelRuleWithResponse call
func (GetServiceLevelRuleResponse) Status ¶
func (r GetServiceLevelRuleResponse) Status() string
Status returns HTTPResponse.Status
func (GetServiceLevelRuleResponse) StatusCode ¶
func (r GetServiceLevelRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetServiceLevelRulesetParams ¶
type GetServiceLevelRulesetParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
GetServiceLevelRulesetParams defines parameters for GetServiceLevelRuleset.
type GetServiceLevelRulesetResponse ¶
type GetServiceLevelRulesetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RulesetResponse
}
func ParseGetServiceLevelRulesetResponse ¶
func ParseGetServiceLevelRulesetResponse(rsp *http.Response) (*GetServiceLevelRulesetResponse, error)
ParseGetServiceLevelRulesetResponse parses an HTTP response from a GetServiceLevelRulesetWithResponse call
func (GetServiceLevelRulesetResponse) Status ¶
func (r GetServiceLevelRulesetResponse) Status() string
Status returns HTTPResponse.Status
func (GetServiceLevelRulesetResponse) StatusCode ¶
func (r GetServiceLevelRulesetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetShipmentParams ¶
type GetShipmentParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
}
GetShipmentParams defines parameters for GetShipment.
type GetShipmentResponse ¶
type GetShipmentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
JSON404 *CreateShipmentErrorResponse
}
func ParseGetShipmentResponse ¶
func ParseGetShipmentResponse(rsp *http.Response) (*GetShipmentResponse, error)
ParseGetShipmentResponse parses an HTTP response from a GetShipmentWithResponse call
func (GetShipmentResponse) Status ¶
func (r GetShipmentResponse) Status() string
Status returns HTTPResponse.Status
func (GetShipmentResponse) StatusCode ¶
func (r GetShipmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetShippingRatesJSONRequestBody ¶
type GetShippingRatesJSONRequestBody = ShippingRatesRequest
GetShippingRatesJSONRequestBody defines body for GetShippingRates for application/json ContentType.
type GetShippingRatesParams ¶
type GetShippingRatesParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
}
GetShippingRatesParams defines parameters for GetShippingRates.
type GetShippingRatesResponse ¶
type GetShippingRatesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShippingRatesResponse
}
func ParseGetShippingRatesResponse ¶
func ParseGetShippingRatesResponse(rsp *http.Response) (*GetShippingRatesResponse, error)
ParseGetShippingRatesResponse parses an HTTP response from a GetShippingRatesWithResponse call
func (GetShippingRatesResponse) Status ¶
func (r GetShippingRatesResponse) Status() string
Status returns HTTPResponse.Status
func (GetShippingRatesResponse) StatusCode ¶
func (r GetShippingRatesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type ItemObject ¶
type ItemObject struct {
// Barcode Barcode of the item
Barcode *string `json:"barcode,omitempty"`
// Cost The unit cost of the item
Cost *struct {
Amount float32 `json:"amount"`
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency string `json:"currency"`
} `json:"cost,omitempty"`
// DangerousGoods If the item is classified as dangerous goods. Usually required for cross-border shipping.
DangerousGoods *bool `json:"dangerous_goods,omitempty"`
// Description Description of the item
Description *string `json:"description,omitempty"`
// HsCode HS Code of the item. Usually required for cross-border shipping.
HsCode *string `json:"hs_code,omitempty"`
// ImageLink Image URL of the item
ImageLink *string `json:"image_link,omitempty"`
// Notes Additional information about the item
Notes *string `json:"notes,omitempty"`
// OriginCountry Country of origin of the item. Usually required for cross-border shipping.
OriginCountry *string `json:"origin_country,omitempty"`
// Price The unit price of the item
Price *struct {
Amount float32 `json:"amount"`
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency string `json:"currency"`
} `json:"price,omitempty"`
Quantity *int `json:"quantity,omitempty"`
// Sku SKU ID of the item
Sku *string `json:"sku,omitempty"`
// Weight The weight of the item
Weight *struct {
// Unit Default weight unit is `kg` if not provided.
Unit *ItemObjectWeightUnit `json:"unit,omitempty"`
Value *float32 `json:"value,omitempty"`
} `json:"weight,omitempty"`
}
ItemObject defines model for item-object.
type ItemObjectWeightUnit ¶
type ItemObjectWeightUnit string
ItemObjectWeightUnit Default weight unit is `kg` if not provided.
const (
ItemObjectWeightUnitKg ItemObjectWeightUnit = "kg"
)
Defines values for ItemObjectWeightUnit.
type ItemRequest ¶
type ItemRequest struct {
// Barcode Barcode of the item
Barcode *string `json:"barcode,omitempty"`
// Battery Battery details of the item. Usually required for cross-border shipping.
Battery *struct {
MaterialType *ItemRequestBatteryMaterialType `json:"material_type,omitempty"`
PackingType *ItemRequestBatteryPackingType `json:"packing_type,omitempty"`
} `json:"battery,omitempty"`
// Cost The unit cost of the item
Cost *struct {
Amount float32 `json:"amount"`
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency string `json:"currency"`
} `json:"cost,omitempty"`
// DangerousGoods If the item is classified as dangerous goods. Usually required for cross-border shipping.
DangerousGoods *bool `json:"dangerous_goods,omitempty"`
// Description Description of the item
Description string `json:"description"`
// HsCode HS Code of the item. Usually required for cross-border shipping.
HsCode *string `json:"hs_code,omitempty"`
// ImageLink Image URL of the item
ImageLink *string `json:"image_link,omitempty"`
// Notes Additional information about the item
Notes *string `json:"notes,omitempty"`
// OriginCountry Country of origin of the item. Usually required for cross-border shipping.
OriginCountry *string `json:"origin_country,omitempty"`
// Price The unit price of the item
Price struct {
Amount float32 `json:"amount"`
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency string `json:"currency"`
} `json:"price"`
Quantity int `json:"quantity"`
// Sku SKU ID of the item
Sku string `json:"sku"`
// Weight The weight of the item
Weight *struct {
// Unit Default weight unit is `kg` if not provided.
Unit *ItemRequestWeightUnit `json:"unit,omitempty"`
Value *float32 `json:"value,omitempty"`
} `json:"weight,omitempty"`
}
ItemRequest defines model for item-request.
type ItemRequestBatteryMaterialType ¶
type ItemRequestBatteryMaterialType string
ItemRequestBatteryMaterialType defines model for ItemRequest.Battery.MaterialType.
const ( LithiumIon ItemRequestBatteryMaterialType = "lithium_ion" LithiumMetal ItemRequestBatteryMaterialType = "lithium_metal" )
Defines values for ItemRequestBatteryMaterialType.
type ItemRequestBatteryPackingType ¶
type ItemRequestBatteryPackingType string
ItemRequestBatteryPackingType defines model for ItemRequest.Battery.PackingType.
const ( ContainedInEquipment ItemRequestBatteryPackingType = "contained_in_equipment" PackedWithEquipment ItemRequestBatteryPackingType = "packed_with_equipment" )
Defines values for ItemRequestBatteryPackingType.
type ItemRequestWeightUnit ¶
type ItemRequestWeightUnit string
ItemRequestWeightUnit Default weight unit is `kg` if not provided.
const (
ItemRequestWeightUnitKg ItemRequestWeightUnit = "kg"
)
Defines values for ItemRequestWeightUnit.
type ListAttrbutesParams ¶
type ListAttrbutesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
ListAttrbutesParams defines parameters for ListAttrbutes.
type ListAttrbutesResponse ¶
type ListAttrbutesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]AttributeResponse
}
func ParseListAttrbutesResponse ¶
func ParseListAttrbutesResponse(rsp *http.Response) (*ListAttrbutesResponse, error)
ParseListAttrbutesResponse parses an HTTP response from a ListAttrbutesWithResponse call
func (ListAttrbutesResponse) Status ¶
func (r ListAttrbutesResponse) Status() string
Status returns HTTPResponse.Status
func (ListAttrbutesResponse) StatusCode ¶
func (r ListAttrbutesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListAutomationRulesParams ¶
type ListAutomationRulesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
ListAutomationRulesParams defines parameters for ListAutomationRules.
type ListAutomationRulesResponse ¶
type ListAutomationRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]AutomationRuleResponse
}
func ParseListAutomationRulesResponse ¶
func ParseListAutomationRulesResponse(rsp *http.Response) (*ListAutomationRulesResponse, error)
ParseListAutomationRulesResponse parses an HTTP response from a ListAutomationRulesWithResponse call
func (ListAutomationRulesResponse) Status ¶
func (r ListAutomationRulesResponse) Status() string
Status returns HTTPResponse.Status
func (ListAutomationRulesResponse) StatusCode ¶
func (r ListAutomationRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListAutomationRulesetsParams ¶
type ListAutomationRulesetsParams struct {
// Merchant merchant id
Merchant *string `form:"merchant,omitempty" json:"merchant,omitempty"`
// EntityType Shipment entity type FORWARD or REVERSE
EntityType *string `form:"entity-type,omitempty" json:"entity-type,omitempty"`
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
ListAutomationRulesetsParams defines parameters for ListAutomationRulesets.
type ListAutomationRulesetsResponse ¶
type ListAutomationRulesetsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]RulesetResponse
}
func ParseListAutomationRulesetsResponse ¶
func ParseListAutomationRulesetsResponse(rsp *http.Response) (*ListAutomationRulesetsResponse, error)
ParseListAutomationRulesetsResponse parses an HTTP response from a ListAutomationRulesetsWithResponse call
func (ListAutomationRulesetsResponse) Status ¶
func (r ListAutomationRulesetsResponse) Status() string
Status returns HTTPResponse.Status
func (ListAutomationRulesetsResponse) StatusCode ¶
func (r ListAutomationRulesetsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListCarrierAccountsParams ¶
type ListCarrierAccountsParams struct {
Status *ListCarrierAccountsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
ListCarrierAccountsParams defines parameters for ListCarrierAccounts.
type ListCarrierAccountsParamsStatus ¶
type ListCarrierAccountsParamsStatus string
ListCarrierAccountsParamsStatus defines parameters for ListCarrierAccounts.
const ( Active ListCarrierAccountsParamsStatus = "active" Deleted ListCarrierAccountsParamsStatus = "deleted" Inactive ListCarrierAccountsParamsStatus = "inactive" )
Defines values for ListCarrierAccountsParamsStatus.
type ListCarrierAccountsResponse ¶
type ListCarrierAccountsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]CarrierAccountEndpointObject
}
func ParseListCarrierAccountsResponse ¶
func ParseListCarrierAccountsResponse(rsp *http.Response) (*ListCarrierAccountsResponse, error)
ParseListCarrierAccountsResponse parses an HTTP response from a ListCarrierAccountsWithResponse call
func (ListCarrierAccountsResponse) Status ¶
func (r ListCarrierAccountsResponse) Status() string
Status returns HTTPResponse.Status
func (ListCarrierAccountsResponse) StatusCode ¶
func (r ListCarrierAccountsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListManifestsParams ¶
type ListManifestsParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
ListManifestsParams defines parameters for ListManifests.
type ListManifestsResponse ¶
type ListManifestsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]ManifestResponse
}
func ParseListManifestsResponse ¶
func ParseListManifestsResponse(rsp *http.Response) (*ListManifestsResponse, error)
ParseListManifestsResponse parses an HTTP response from a ListManifestsWithResponse call
func (ListManifestsResponse) Status ¶
func (r ListManifestsResponse) Status() string
Status returns HTTPResponse.Status
func (ListManifestsResponse) StatusCode ¶
func (r ListManifestsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListServiceLevelRulesParams ¶
type ListServiceLevelRulesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
ListServiceLevelRulesParams defines parameters for ListServiceLevelRules.
type ListServiceLevelRulesResponse ¶
type ListServiceLevelRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]ServiceLevelRuleResponse
}
func ParseListServiceLevelRulesResponse ¶
func ParseListServiceLevelRulesResponse(rsp *http.Response) (*ListServiceLevelRulesResponse, error)
ParseListServiceLevelRulesResponse parses an HTTP response from a ListServiceLevelRulesWithResponse call
func (ListServiceLevelRulesResponse) Status ¶
func (r ListServiceLevelRulesResponse) Status() string
Status returns HTTPResponse.Status
func (ListServiceLevelRulesResponse) StatusCode ¶
func (r ListServiceLevelRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListServiceLevelRulesetsParams ¶
type ListServiceLevelRulesetsParams struct {
// Merchant merchant id
Merchant *string `form:"merchant,omitempty" json:"merchant,omitempty"`
// EntityType Shipment entity type FORWARD or REVERSE
EntityType *string `form:"entity-type,omitempty" json:"entity-type,omitempty"`
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
ListServiceLevelRulesetsParams defines parameters for ListServiceLevelRulesets.
type ListServiceLevelRulesetsResponse ¶
type ListServiceLevelRulesetsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]RulesetResponse
}
func ParseListServiceLevelRulesetsResponse ¶
func ParseListServiceLevelRulesetsResponse(rsp *http.Response) (*ListServiceLevelRulesetsResponse, error)
ParseListServiceLevelRulesetsResponse parses an HTTP response from a ListServiceLevelRulesetsWithResponse call
func (ListServiceLevelRulesetsResponse) Status ¶
func (r ListServiceLevelRulesetsResponse) Status() string
Status returns HTTPResponse.Status
func (ListServiceLevelRulesetsResponse) StatusCode ¶
func (r ListServiceLevelRulesetsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListShipmentsParams ¶
type ListShipmentsParams struct {
// SearchString The search string to find shipments using shipment data such as carrier tracking number, order reference, shipment reference, customer name, email etc.
SearchString *string `form:"search_string,omitempty" json:"search_string,omitempty"`
// OrderRef The string to be used to fetch shipments for a given order reference.
OrderRef *string `form:"order_ref,omitempty" json:"order_ref,omitempty"`
// Merchant The merchant parameter filters shipments for a given merchant. This parameter can be used multiple times to filter results for multiple merchants.
Merchant *string `form:"merchant,omitempty" json:"merchant,omitempty"`
// ShipmentType The shipment type can either be `forward` or `reverse`. If not passed, then both types of shipments will be included in the results.
ShipmentType *string `form:"shipment_type,omitempty" json:"shipment_type,omitempty"`
// CreationDateFrom The start date in ISO 8601 format to filter the results using shipment creation date.
CreationDateFrom *string `form:"creation_date_from,omitempty" json:"creation_date_from,omitempty"`
// CreationDateTo The end date in ISO 8601 format to filter the results using shipment creation date.
CreationDateTo *string `form:"creation_date_to,omitempty" json:"creation_date_to,omitempty"`
// UpdateDateFrom The start date in ISO 8601 format to filter results, returning shipments that were either created OR updated during this time period.
UpdateDateFrom *string `form:"update_date_from,omitempty" json:"update_date_from,omitempty"`
// UpdateDateTo The end date in ISO 8601 format to filter results, returning shipments that were either created OR updated during this time period.
UpdateDateTo *string `form:"update_date_to,omitempty" json:"update_date_to,omitempty"`
// Page The page number of the result set, starting from 0. Defaults to the first page (page 0).
Page *string `form:"page,omitempty" json:"page,omitempty"`
// PageSize The number of results to be included in the response, ranging from 10 to 100. Defaults to page size of 10.
PageSize *string `form:"page_size,omitempty" json:"page_size,omitempty"`
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
}
ListShipmentsParams defines parameters for ListShipments.
type ListShipmentsResponse ¶
type ListShipmentsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]ShipmentObject
}
func ParseListShipmentsResponse ¶
func ParseListShipmentsResponse(rsp *http.Response) (*ListShipmentsResponse, error)
ParseListShipmentsResponse parses an HTTP response from a ListShipmentsWithResponse call
func (ListShipmentsResponse) Status ¶
func (r ListShipmentsResponse) Status() string
Status returns HTTPResponse.Status
func (ListShipmentsResponse) StatusCode ¶
func (r ListShipmentsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type LocationCode ¶ added in v0.5.0
type LocationCode struct {
// Type Type of location code
Type LocationCodeType `json:"type"`
// Value The location code value
Value string `json:"value"`
}
LocationCode Location code identifier for the address
type LocationCodeType ¶ added in v0.5.0
type LocationCodeType string
LocationCodeType Type of location code
type LocationObject ¶
type LocationObject struct {
// Address1 Address Line 1 (e.g., street, PO Box, or company name).
Address1 *string `json:"address1,omitempty"`
// Address2 Address Line 2 (e.g., apartment, floor, unit, or building).
Address2 *string `json:"address2,omitempty"`
// AddressCodes Array of location codes for the address
AddressCodes *[]AddressCode `json:"address_codes,omitempty"`
// AlternatePhone Alternate phone number for contact in E164 Format with country code. e.g., +16175551210
AlternatePhone *string `json:"alternate_phone,omitempty"`
// Area District, suburb or neighbourhood, represented by the Carriyo Area Code if known. If not, it's a free text.
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
Area *string `json:"area,omitempty"`
// AreaCoords (Read-only) Approximate latitude and longitude for the area, if found in Carriyo's database. e.g., [25.1949849, 55.2784141]
AreaCoords *[]float32 `json:"area_coords,omitempty"`
// Building Building number or name
Building *string `json:"building,omitempty"`
// City City, town, or village, represented by the Carriyo City Code if known. If not, it's a free text.
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
City *string `json:"city,omitempty"`
// CityCoords (Read-only) Approximate latitude and longitude for the city, if found in Carriyo's database. e.g., [25.1949849, 55.2784141]
CityCoords *[]float32 `json:"city_coords,omitempty"`
// CollectionPointId ID of the carrier's collection point for deliveries held at the carrier location for collection
CollectionPointId *string `json:"collection_point_id,omitempty"`
// ContactEmail Email address for contact
// Conditionally mandatory based on Account Settings
ContactEmail *string `json:"contact_email,omitempty"`
// ContactName Name of the contact person or business
ContactName *string `json:"contact_name,omitempty"`
// ContactPhone Primary phone number for contact in E164 Format with country code. e.g., +16175551212
// Conditionally mandatory based on Account Settings
ContactPhone *string `json:"contact_phone,omitempty"`
// Coords Latitude and longitude (decimal degrees) of the address as an array. e.g., [25.19741, 55.27442]
Coords *[]float32 `json:"coords,omitempty"`
// Country Two-letter country code (ISO 3166-1 alpha-2).
Country *string `json:"country,omitempty"`
// CustomFields Custom address fields in the form of a map:
// “`
// {"field1" : ["value1", "value2"], "field2" : ["value1", "value2"]}
// “`
CustomFields *CustomFields `json:"custom_fields,omitempty"`
// Flat Flat number
Flat *string `json:"flat,omitempty"`
// Floor Floor number
Floor *string `json:"floor,omitempty"`
// InputArea (Ready-only) Preserves the original input provided for "area". It is useful when Carriyo is instructed to automatically recognise the Carriyo area code.
InputArea *string `json:"input_area,omitempty"`
// InputCity (Ready-only) Preserves the original input provided for "city". It is useful when Carriyo is instructed to automatically recognise the Carriyo city code.
InputCity *string `json:"input_city,omitempty"`
// InputState (Ready-only) Preserves the original input provided for "state". It is useful when Carriyo is instructed to automatically recognise the Carriyo state code.
InputState *string `json:"input_state,omitempty"`
// LocationCodes Array of location codes for the address
LocationCodes *[]LocationCode `json:"location_codes,omitempty"`
// Notes Any additional notes e.g., "Leave the parcel next to the bin" or "Collect the parcel from the neighbour"
Notes *string `json:"notes,omitempty"`
// PartnerLocationId ID of the location chosen by the merchant
PartnerLocationId *string `json:"partner_location_id,omitempty"`
// PersonalId ID of the person to whom the shipment is addressed
PersonalId *PersonalId `json:"personal_id,omitempty"`
// PoBox Box number if the address is a PO Box
PoBox *string `json:"po_box,omitempty"`
// Postcode ZIP or postal code
Postcode *string `json:"postcode,omitempty"`
// RegistrationNumbers Array of registration numbers for customs/VAT purposes
RegistrationNumbers *[]RegistrationNumber `json:"registration_numbers,omitempty"`
// State State, county, province, or region, represented by the Carriyo State Code if known. If not, it's a free text.
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
State *string `json:"state,omitempty"`
// Street Street number or name
Street *string `json:"street,omitempty"`
// Type Type of address. i.e. business or residential
Type *LocationObjectType `json:"type,omitempty"`
What3words *string `json:"what3words,omitempty"`
}
LocationObject Either a free-form address or a predefined location.
type LocationObjectType ¶
type LocationObjectType string
LocationObjectType Type of address. i.e. business or residential
const ( LocationObjectTypeBusiness LocationObjectType = "business" LocationObjectTypeResidential LocationObjectType = "residential" )
Defines values for LocationObjectType.
type LocationRequest ¶
type LocationRequest struct {
// PartnerLocationCode You can also pass the unique locaton code intead of the location id
PartnerLocationCode *string `json:"partner_location_code,omitempty"`
// PartnerLocationId Carriyo's internal location id to use for the pickup
PartnerLocationId *string `json:"partner_location_id,omitempty"`
}
LocationRequest Specify the Carriyo location ID (`partner_location_id`), or the location code (`partner_location_code`) you defined when you created the location in Carriyo.
type ManifestRequest ¶
type ManifestRequest struct {
CarrierAccount string `json:"carrier_account"`
Merchant string `json:"merchant"`
Pickup map[string]interface{} `json:"pickup"`
PickupScheduleFrom string `json:"pickup_schedule_from"`
PickupScheduleTo string `json:"pickup_schedule_to"`
ShipManifestDate string `json:"ship_manifest_date"`
ShipmentIds []string `json:"shipment_ids"`
}
ManifestRequest defines model for manifest-request.
type ManifestResponse ¶
type ManifestResponse struct {
CarrierAccount string `json:"carrier_account"`
ManifestId string `json:"manifest_id"`
Merchant string `json:"merchant"`
Pickup map[string]interface{} `json:"pickup"`
PickupScheduleFrom string `json:"pickup_schedule_from"`
PickupScheduleTo string `json:"pickup_schedule_to"`
ShipManifestDate string `json:"ship_manifest_date"`
ShipmentIds []string `json:"shipment_ids"`
}
ManifestResponse defines model for manifest-response.
type NumberAreaConditionField ¶
type NumberAreaConditionField struct {
MaxValue *float32 `json:"max_value,omitempty"`
MinValue *float32 `json:"min_value,omitempty"`
}
NumberAreaConditionField defines model for number-area-condition-field.
type PackageObject ¶
type PackageObject struct {
Dimension *Dimension `json:"dimension,omitempty"`
// PackageReference A reference number to identify the package
PackageReference *string `json:"package_reference,omitempty"`
// Parent A reference number to identify the parent package
Parent *string `json:"parent,omitempty"`
Type interface{} `json:"type,omitempty"`
Weight *Weight `json:"weight,omitempty"`
}
PackageObject List of packages of type pallet or carton in a B2B shipment.
type ParcelItem ¶
type ParcelItem struct {
Quantity *int `json:"quantity,omitempty"`
Sku *string `json:"sku,omitempty"`
}
ParcelItem defines model for parcel-item.
type ParcelObject ¶
type ParcelObject struct {
// Description Description for the parcel provided by the merchant
Description *string `json:"description,omitempty"`
Dimension *Dimension `json:"dimension,omitempty"`
// ParcelId Unique parcel ID generated by Carriyo
ParcelId *string `json:"parcel_id,omitempty"`
ParcelItems *[]ParcelItem `json:"parcel_items,omitempty"`
// PartnerParcelReference Unique parcel reference provided by the merchant
PartnerParcelReference *string `json:"partner_parcel_reference,omitempty"`
Weight *Weight `json:"weight,omitempty"`
}
ParcelObject List of parcels in a B2C shipment.
type ParcelRequest ¶
type ParcelRequest struct {
// Description A description for the parcel
Description *string `json:"description,omitempty"`
Dimension *Dimension `json:"dimension,omitempty"`
ParcelItems *[]ParcelItem `json:"parcel_items,omitempty"`
// PartnerParcelReference A reference number to identify the parcel
PartnerParcelReference *string `json:"partner_parcel_reference,omitempty"`
Weight *Weight `json:"weight,omitempty"`
}
ParcelRequest List of parcels in a B2C shipment.
type PatchAutomationRulesetJSONRequestBody ¶
type PatchAutomationRulesetJSONRequestBody = RulesetRequest
PatchAutomationRulesetJSONRequestBody defines body for PatchAutomationRuleset for application/json ContentType.
type PatchAutomationRulesetParams ¶
type PatchAutomationRulesetParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
PatchAutomationRulesetParams defines parameters for PatchAutomationRuleset.
type PatchAutomationRulesetResponse ¶
type PatchAutomationRulesetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RulesetResponse
}
func ParsePatchAutomationRulesetResponse ¶
func ParsePatchAutomationRulesetResponse(rsp *http.Response) (*PatchAutomationRulesetResponse, error)
ParsePatchAutomationRulesetResponse parses an HTTP response from a PatchAutomationRulesetWithResponse call
func (PatchAutomationRulesetResponse) Status ¶
func (r PatchAutomationRulesetResponse) Status() string
Status returns HTTPResponse.Status
func (PatchAutomationRulesetResponse) StatusCode ¶
func (r PatchAutomationRulesetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PatchServiceLevelRulesetJSONRequestBody ¶
type PatchServiceLevelRulesetJSONRequestBody = RulesetRequest
PatchServiceLevelRulesetJSONRequestBody defines body for PatchServiceLevelRuleset for application/json ContentType.
type PatchServiceLevelRulesetParams ¶
type PatchServiceLevelRulesetParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
PatchServiceLevelRulesetParams defines parameters for PatchServiceLevelRuleset.
type PatchServiceLevelRulesetResponse ¶
type PatchServiceLevelRulesetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RulesetResponse
}
func ParsePatchServiceLevelRulesetResponse ¶
func ParsePatchServiceLevelRulesetResponse(rsp *http.Response) (*PatchServiceLevelRulesetResponse, error)
ParsePatchServiceLevelRulesetResponse parses an HTTP response from a PatchServiceLevelRulesetWithResponse call
func (PatchServiceLevelRulesetResponse) Status ¶
func (r PatchServiceLevelRulesetResponse) Status() string
Status returns HTTPResponse.Status
func (PatchServiceLevelRulesetResponse) StatusCode ¶
func (r PatchServiceLevelRulesetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PaymentObject ¶
type PaymentObject struct {
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency *string `json:"currency,omitempty"`
// PaymentMode Payment mode of the shipment can be `PRE_PAID` or `CASH_ON_DELIVERY`. It defaults to `PRE_PAID` for reverse shipment or if no input is provided.
//
// `PRE_PAID` is the only valid value for reverse shipments.
PaymentMode *PaymentObjectPaymentMode `json:"payment_mode,omitempty"`
// PendingAmount Outstanding amount payable on delivery of the shipment. It defaults to 0 if no input is provided.
PendingAmount *float64 `json:"pending_amount,omitempty"`
// TotalAmount Total value of the shipment
TotalAmount *float64 `json:"total_amount,omitempty"`
}
PaymentObject Payment details including the total value of the shipment and any pending Cash on Delivery amount.
type PaymentObjectPaymentMode ¶
type PaymentObjectPaymentMode string
PaymentObjectPaymentMode Payment mode of the shipment can be `PRE_PAID` or `CASH_ON_DELIVERY`. It defaults to `PRE_PAID` for reverse shipment or if no input is provided.
`PRE_PAID` is the only valid value for reverse shipments.
const ( PaymentObjectPaymentModeCASHONDELIVERY PaymentObjectPaymentMode = "CASH_ON_DELIVERY" PaymentObjectPaymentModePREPAID PaymentObjectPaymentMode = "PRE_PAID" )
Defines values for PaymentObjectPaymentMode.
type PaymentRequest ¶
type PaymentRequest struct {
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency string `json:"currency"`
// PaymentMode Payment mode of the shipment can be `PRE_PAID` or `CASH_ON_DELIVERY`. It defaults to `PRE_PAID` for reverse shipment or if no input is provided.
//
// `PRE_PAID` is the only valid value for reverse shipments.
PaymentMode *PaymentRequestPaymentMode `json:"payment_mode,omitempty"`
// PendingAmount Outstanding amount payable on delivery of the shipment. It defaults to 0 for reverse shipment or if no input is provided.
PendingAmount *float64 `json:"pending_amount,omitempty"`
// TotalAmount Total value of the shipment
TotalAmount float64 `json:"total_amount"`
}
PaymentRequest Payment details including the total value of the shipment and any pending Cash on Delivery amount.
type PaymentRequestPaymentMode ¶
type PaymentRequestPaymentMode string
PaymentRequestPaymentMode Payment mode of the shipment can be `PRE_PAID` or `CASH_ON_DELIVERY`. It defaults to `PRE_PAID` for reverse shipment or if no input is provided.
`PRE_PAID` is the only valid value for reverse shipments.
const ( PaymentRequestPaymentModeCASHONDELIVERY PaymentRequestPaymentMode = "CASH_ON_DELIVERY" PaymentRequestPaymentModePREPAID PaymentRequestPaymentMode = "PRE_PAID" )
Defines values for PaymentRequestPaymentMode.
type PersonalId ¶
type PersonalId struct {
// Id ID number
Id *string `json:"id,omitempty"`
// Type ID type
Type *string `json:"type,omitempty"`
}
PersonalId ID of the person to whom the shipment is addressed
type PostShippingInfo ¶
type PostShippingInfo struct {
// CarrierPdfLabelUrl The url of PDF label provided by the carrier
CarrierPdfLabelUrl *string `json:"carrier_pdf_label_url,omitempty"`
// CarrierStatus The raw status provided by the carrier
CarrierStatus *string `json:"carrier_status,omitempty"`
// CarrierStatusDate The Date when the carrier status was last updated in ISO 8601 format. Example: 2022-01-01T17:07:05.000Z
CarrierStatusDate *time.Time `json:"carrier_status_date,omitempty"`
// CarrierStatusDescription The status description provided by the carrier
CarrierStatusDescription *string `json:"carrier_status_description,omitempty"`
// CarrierStatusLocation The last known location of the shipment provided by the carrier. For example: Dubai
CarrierStatusLocation *string `json:"carrier_status_location,omitempty"`
// CarrierTrackingUrl The url of tracking page provided by the carrier
CarrierTrackingUrl *string `json:"carrier_tracking_url,omitempty"`
// CarriyoFeedbackUrl The url of feedback page provided by the Carriyo
CarriyoFeedbackUrl *string `json:"carriyo_feedback_url,omitempty"`
// CarriyoPdfLabelUrl The url of PDF label generated by Carriyo
CarriyoPdfLabelUrl *string `json:"carriyo_pdf_label_url,omitempty"`
// CarriyoPinpointUrl The url of pinpoint page provided by the Carriyo
CarriyoPinpointUrl *string `json:"carriyo_pinpoint_url,omitempty"`
// CarriyoTrackingUrl The url of tracking page provided by the Carriyo
CarriyoTrackingUrl *string `json:"carriyo_tracking_url,omitempty"`
// CarriyoZplLabelUrl The url of ZPL label generated by Carriyo
CarriyoZplLabelUrl *string `json:"carriyo_zpl_label_url,omitempty"`
// DefaultLabelUrl The url for the default label - either carrier or carriyo generated
DefaultLabelUrl *string `json:"default_label_url,omitempty"`
// Documents Shipping documents such as commercial invoice, packing list etc
Documents *[]DocumentObject `json:"documents,omitempty"`
// DriverName The name of the driver delivering the shipment
DriverName *string `json:"driver_name,omitempty"`
// DriverPhone The phone number of the driver delivering the shipment
DriverPhone *string `json:"driver_phone,omitempty"`
ErrorDetails *[]ErrorDetail `json:"error_details,omitempty"`
// EstimatedDeliveryDate The date the shipment is expected to be delivered in ISO 8601 format. Example: 2022-01-01T17:07:05.000Z
EstimatedDeliveryDate *time.Time `json:"estimated_delivery_date,omitempty"`
// EstimatedShipDate The date the shipment is expected to be shipped in ISO 8601 format. Example: 2022-03-01T17:07:05.000Z
EstimatedShipDate *time.Time `json:"estimated_ship_date,omitempty"`
// FailedDeliveryAttempts The total number of failed delivery attempts on the shipment
FailedDeliveryAttempts *float32 `json:"failed_delivery_attempts,omitempty"`
KeyMilestones *struct {
AwaitingCustomerCollection *string `json:"awaiting_customer_collection,omitempty"`
Booked *string `json:"booked,omitempty"`
Cancelled *string `json:"cancelled,omitempty"`
CancelledByCarrier *string `json:"cancelled_by_carrier,omitempty"`
Delayed *string `json:"delayed,omitempty"`
Delivered *string `json:"delivered,omitempty"`
DeliveryConfirmed *string `json:"delivery_confirmed,omitempty"`
Error *string `json:"error,omitempty"`
FailedCollectionAttempt *string `json:"failed_collection_attempt,omitempty"`
FailedDeliveryAttempt *string `json:"failed_delivery_attempt,omitempty"`
InTransit *string `json:"in_transit,omitempty"`
Missing *string `json:"missing,omitempty"`
OutForDelivery *string `json:"out_for_delivery,omitempty"`
Pending *string `json:"pending,omitempty"`
ReadyForReturn *string `json:"ready_for_return,omitempty"`
ReadyToShip *string `json:"ready_to_ship,omitempty"`
ReturnConfirmed *string `json:"return_confirmed,omitempty"`
ReturnInTransit *string `json:"return_in_transit,omitempty"`
Returned *string `json:"returned,omitempty"`
Shipped *string `json:"shipped,omitempty"`
Suspended *string `json:"suspended,omitempty"`
} `json:"key_milestones,omitempty"`
// ParcelTrackingNumbers Tracking numbers for individual parcels if generated by the carrier
ParcelTrackingNumbers *[]struct {
ParcelId *string `json:"parcel_id,omitempty"`
TrackingNumber *string `json:"tracking_number,omitempty"`
} `json:"parcel_tracking_numbers,omitempty"`
// ProofOfDelivery The url of document or image containing the proof of delivery
ProofOfDelivery *string `json:"proof_of_delivery,omitempty"`
// ReasonCode The reason code linked to the status (one of the standard Carriyo reason codes or a merchant defined status)
ReasonCode *string `json:"reason_code,omitempty"`
// RecipientName The name of the recipient to whom shipment was delivered
RecipientName *string `json:"recipient_name,omitempty"`
// Status The status of the shipment (one of the standard Carriyo status)
Status *string `json:"status,omitempty"`
// TrackingNo The unique shipment tracking number provided by the carrier
TrackingNo *string `json:"tracking_no,omitempty"`
}
PostShippingInfo Booking details such as tracking number, labels etc.
type PromisedDeliveryDateRequest ¶
type PromisedDeliveryDateRequest struct {
// RevisedPromisedDeliveryDate Revised promised delivery date in ISO 8601 format. For Example: 2020-09-03T17:07:05.000+1:00 represents the date-time in UTC+1 time zone or 2020-09-03T17:07:05.000Z represents date-time in UTC (zulu) time zone
RevisedPromisedDeliveryDate *time.Time `json:"revised_promised_delivery_date,omitempty"`
}
PromisedDeliveryDateRequest Revised promised delivery date
type ReadyToShipJSONRequestBody ¶
type ReadyToShipJSONRequestBody = UpdateParcelsRequest
ReadyToShipJSONRequestBody defines body for ReadyToShip for application/json ContentType.
type ReadyToShipParams ¶
type ReadyToShipParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
}
ReadyToShipParams defines parameters for ReadyToShip.
type ReadyToShipResponse ¶
type ReadyToShipResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
}
func ParseReadyToShipResponse ¶
func ParseReadyToShipResponse(rsp *http.Response) (*ReadyToShipResponse, error)
ParseReadyToShipResponse parses an HTTP response from a ReadyToShipWithResponse call
func (ReadyToShipResponse) Status ¶
func (r ReadyToShipResponse) Status() string
Status returns HTTPResponse.Status
func (ReadyToShipResponse) StatusCode ¶
func (r ReadyToShipResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ReassignShipmentJSONBody ¶
type ReassignShipmentJSONBody struct {
// CarrierAccount Carrier account chosen for the shipment. Should contain either the carrier account id or carrier account name. Carrier account id takes precedence if both fields are passed.
CarrierAccount *CarrierAccountRequest `json:"carrier_account,omitempty"`
}
ReassignShipmentJSONBody defines parameters for ReassignShipment.
type ReassignShipmentJSONRequestBody ¶
type ReassignShipmentJSONRequestBody ReassignShipmentJSONBody
ReassignShipmentJSONRequestBody defines body for ReassignShipment for application/json ContentType.
type ReassignShipmentParams ¶
type ReassignShipmentParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
ReassignShipmentParams defines parameters for ReassignShipment.
type ReassignShipmentResponse ¶
type ReassignShipmentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
}
func ParseReassignShipmentResponse ¶
func ParseReassignShipmentResponse(rsp *http.Response) (*ReassignShipmentResponse, error)
ParseReassignShipmentResponse parses an HTTP response from a ReassignShipmentWithResponse call
func (ReassignShipmentResponse) Status ¶
func (r ReassignShipmentResponse) Status() string
Status returns HTTPResponse.Status
func (ReassignShipmentResponse) StatusCode ¶
func (r ReassignShipmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ReferencesObject ¶
type ReferencesObject struct {
// AlternateReference An alternate reference that can be used for searching shipments in Carriyo or mapping references to the carrier.
AlternateReference *string `json:"alternate_reference,omitempty"`
// OtherReferences A list of references that can be used for searching shipments in Carriyo
OtherReferences *[]string `json:"other_references,omitempty"`
// PartnerOrderReference Order reference provided by the merchant
PartnerOrderReference *string `json:"partner_order_reference,omitempty"`
// PartnerShipmentReference Unique shipment reference provided by the merchant
PartnerShipmentReference *string `json:"partner_shipment_reference,omitempty"`
}
ReferencesObject References for a shipment, provided by the merchant.
type ReferencesRequest ¶
type ReferencesRequest struct {
// AlternateReference An alternate reference that can be used for searching shipments in Carriyo or mapping references to the carrier.
AlternateReference *string `json:"alternate_reference,omitempty"`
// OtherReferences A list of references that can be used for searching shipments in Carriyo
OtherReferences *[]string `json:"other_references,omitempty"`
// PartnerOrderReference Order reference provided by the merchant
PartnerOrderReference string `json:"partner_order_reference"`
// PartnerShipmentReference Unique shipment reference provided by the merchant
PartnerShipmentReference string `json:"partner_shipment_reference"`
}
ReferencesRequest References for a shipment, provided by the merchant.
The `partner_order_reference` is mandatory but not required to be unique. It is usually the customer facing order number.
The `partner_shipment_reference` must be unique for every shipment. It is mandatory, but is copied from `partner_order_reference` if it is not provided.
If a single order has multiple shipments, then they will share the `partner_order_reference` but have unique `partner_shipment_reference`.
type RefreshLabelParams ¶
type RefreshLabelParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
}
RefreshLabelParams defines parameters for RefreshLabel.
type RefreshLabelResponse ¶
type RefreshLabelResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
Awb *string `json:"awb,omitempty"`
}
}
func ParseRefreshLabelResponse ¶
func ParseRefreshLabelResponse(rsp *http.Response) (*RefreshLabelResponse, error)
ParseRefreshLabelResponse parses an HTTP response from a RefreshLabelWithResponse call
func (RefreshLabelResponse) Status ¶
func (r RefreshLabelResponse) Status() string
Status returns HTTPResponse.Status
func (RefreshLabelResponse) StatusCode ¶
func (r RefreshLabelResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegistrationNumber ¶ added in v0.5.0
type RegistrationNumber struct {
// IssuerCountryCode ISO 3166-1 alpha-2 country code of the issuer
IssuerCountryCode string `json:"issuer_country_code"`
// TypeCode Type of registration number
TypeCode RegistrationNumberTypeCode `json:"type_code"`
// Value The registration number value
Value string `json:"value"`
}
RegistrationNumber Registration number for customs/VAT purposes
type RegistrationNumberTypeCode ¶ added in v0.5.0
type RegistrationNumberTypeCode string
RegistrationNumberTypeCode Type of registration number
const ( CNP RegistrationNumberTypeCode = "CNP" DUN RegistrationNumberTypeCode = "DUN" EIN RegistrationNumberTypeCode = "EIN" EOR RegistrationNumberTypeCode = "EOR" FED RegistrationNumberTypeCode = "FED" GST RegistrationNumberTypeCode = "GST" IE RegistrationNumberTypeCode = "IE" INN RegistrationNumberTypeCode = "INN" IOSS RegistrationNumberTypeCode = "IOSS" KPP RegistrationNumberTypeCode = "KPP" OGR RegistrationNumberTypeCode = "OGR" OKP RegistrationNumberTypeCode = "OKP" PAN RegistrationNumberTypeCode = "PAN" SDT RegistrationNumberTypeCode = "SDT" SSN RegistrationNumberTypeCode = "SSN" STA RegistrationNumberTypeCode = "STA" VAT RegistrationNumberTypeCode = "VAT" )
Defines values for RegistrationNumberTypeCode.
type ReprocessShipmentJSONRequestBody ¶
type ReprocessShipmentJSONRequestBody = ShipmentPatchRequest
ReprocessShipmentJSONRequestBody defines body for ReprocessShipment for application/json ContentType.
type ReprocessShipmentParams ¶
type ReprocessShipmentParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
ReprocessShipmentParams defines parameters for ReprocessShipment.
type ReprocessShipmentResponse ¶
type ReprocessShipmentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
}
func ParseReprocessShipmentResponse ¶
func ParseReprocessShipmentResponse(rsp *http.Response) (*ReprocessShipmentResponse, error)
ParseReprocessShipmentResponse parses an HTTP response from a ReprocessShipmentWithResponse call
func (ReprocessShipmentResponse) Status ¶
func (r ReprocessShipmentResponse) Status() string
Status returns HTTPResponse.Status
func (ReprocessShipmentResponse) StatusCode ¶
func (r ReprocessShipmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type RetryManifestParams ¶
type RetryManifestParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
RetryManifestParams defines parameters for RetryManifest.
type RetryManifestResponse ¶
type RetryManifestResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
}
func ParseRetryManifestResponse ¶
func ParseRetryManifestResponse(rsp *http.Response) (*RetryManifestResponse, error)
ParseRetryManifestResponse parses an HTTP response from a RetryManifestWithResponse call
func (RetryManifestResponse) Status ¶
func (r RetryManifestResponse) Status() string
Status returns HTTPResponse.Status
func (RetryManifestResponse) StatusCode ¶
func (r RetryManifestResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RulesetRequest ¶
type RulesetRequest struct {
// Countries List of country iso2 codes used in Ruleset. Use ["_ANY"] for all countries
Countries []string `json:"countries"`
EntityType RulesetRequestEntityType `json:"entity_type"`
// Merchants List of Merchant ids used in Ruleset. Use ["_ANY"] for all merchants
Merchants []string `json:"merchants"`
Name string `json:"name"`
Status StatusField `json:"status"`
}
RulesetRequest defines model for ruleset-request.
type RulesetRequestEntityType ¶
type RulesetRequestEntityType string
RulesetRequestEntityType defines model for RulesetRequest.EntityType.
const ( RulesetRequestEntityTypeFORWARD RulesetRequestEntityType = "FORWARD" RulesetRequestEntityTypeREVERSE RulesetRequestEntityType = "REVERSE" )
Defines values for RulesetRequestEntityType.
type RulesetResponse ¶
type RulesetResponse struct {
// Countries List of country iso2 codes used in Ruleset. Use ["_ANY"] for all countries
Countries *[]string `json:"countries,omitempty"`
CreationDate *time.Time `json:"creation_date,omitempty"`
EntityType *RulesetResponseEntityType `json:"entity_type,omitempty"`
// Merchants List of Merchant ids used in Ruleset. Use ["_ANY"] for all merchants
Merchants *[]string `json:"merchants,omitempty"`
Name *string `json:"name,omitempty"`
RuleSetId *string `json:"rule_set_id,omitempty"`
Status *StatusField `json:"status,omitempty"`
Tenant *string `json:"tenant,omitempty"`
UpdateDate *time.Time `json:"update_date,omitempty"`
}
RulesetResponse defines model for ruleset-response.
type RulesetResponseEntityType ¶
type RulesetResponseEntityType string
RulesetResponseEntityType defines model for RulesetResponse.EntityType.
const ( RulesetResponseEntityTypeFORWARD RulesetResponseEntityType = "FORWARD" RulesetResponseEntityTypeREVERSE RulesetResponseEntityType = "REVERSE" )
Defines values for RulesetResponseEntityType.
type SequencesRequest ¶
type SequencesRequest = []struct {
RuleId *string `json:"rule_id,omitempty"`
Sequence *float32 `json:"sequence,omitempty"`
}
SequencesRequest defines model for sequences-request.
type ServiceLevelRuleRequest ¶
type ServiceLevelRuleRequest struct {
// CarrierIds shipment.source.source_type matches condition
CarrierIds *StringConditionField `json:"carrier_ids,omitempty"`
ConfigType *ServiceLevelRuleRequestConfigType `json:"config_type,omitempty"`
// CustomConditions shipment.custom_attributes matches condition
CustomConditions *CustomAttributesConditionField `json:"custom_conditions,omitempty"`
// Days Days when rule applies
Days *DaysField `json:"days,omitempty"`
// DeliveryType shipment.delivery.delivery_type matches condition
DeliveryType *StringConditionField `json:"delivery_type,omitempty"`
Description *string `json:"description,omitempty"`
// DropoffPartnerLocationIds shipment.dropoff.partner_location_id matches condition
DropoffPartnerLocationIds *StringConditionField `json:"dropoff_partner_location_ids,omitempty"`
// DropoffV2 shipment.dropoff country state city area condition
DropoffV2 *GeographyConditionField `json:"dropoff_v2,omitempty"`
// EndTime Time range when rule applies
EndTime *float32 `json:"end_time,omitempty"`
// GrossWeight shipment.parcels gross weight is inside range
GrossWeight *NumberAreaConditionField `json:"gross_weight,omitempty"`
// Merchants shipment.merchant matches condition
Merchants *StringConditionField `json:"merchants,omitempty"`
// OrderType shipment.order_type matches condition
OrderType *StringConditionField `json:"order_type,omitempty"`
// PickupPartnerLocationIds shipment.pickup.partner_location_id matches condition
PickupPartnerLocationIds *StringConditionField `json:"pickup_partner_location_ids,omitempty"`
// PickupV2 shipment.pickup country state city area condition
PickupV2 *GeographyConditionField `json:"pickup_v2,omitempty"`
RuleName string `json:"rule_name"`
// Sequence Sequence number used for rules prioritisation (lower is more important)
Sequence float32 `json:"sequence"`
// SourceType shipment.source.source_type matches condition
SourceType *StringConditionField `json:"source_type,omitempty"`
// StartTime Time range when rule applies
StartTime *float32 `json:"start_time,omitempty"`
Status StatusField `json:"status"`
// VolumetricWeight shipment.parcels volumetric weight is inside range
VolumetricWeight *NumberAreaConditionField `json:"volumetric_weight,omitempty"`
}
ServiceLevelRuleRequest defines model for service-level-rule-request.
type ServiceLevelRuleRequestConfigType ¶
type ServiceLevelRuleRequestConfigType string
ServiceLevelRuleRequestConfigType defines model for ServiceLevelRuleRequest.ConfigType.
const ( ServiceLevelRuleRequestConfigTypeDELIVERY ServiceLevelRuleRequestConfigType = "DELIVERY" ServiceLevelRuleRequestConfigTypeFULFILLMENT ServiceLevelRuleRequestConfigType = "FULFILLMENT" ServiceLevelRuleRequestConfigTypePROMISED ServiceLevelRuleRequestConfigType = "PROMISED" ServiceLevelRuleRequestConfigTypeSHIPPING ServiceLevelRuleRequestConfigType = "SHIPPING" )
Defines values for ServiceLevelRuleRequestConfigType.
type ServiceLevelRuleResponse ¶
type ServiceLevelRuleResponse struct {
CarrierIds *StringConditionField `json:"carrier_ids,omitempty"`
ConfigType *ServiceLevelRuleResponseConfigType `json:"config_type,omitempty"`
CreationDate *time.Time `json:"creation_date,omitempty"`
CustomConditions *CustomAttributesConditionField `json:"custom_conditions,omitempty"`
Days *DaysField `json:"days,omitempty"`
DeliveryType *StringConditionField `json:"delivery_type,omitempty"`
Description *string `json:"description,omitempty"`
DropoffPartnerLocationIds *StringConditionField `json:"dropoff_partner_location_ids,omitempty"`
DropoffV2 *GeographyConditionField `json:"dropoff_v2,omitempty"`
EndTime *float32 `json:"end_time,omitempty"`
GrossWeight *NumberAreaConditionField `json:"gross_weight,omitempty"`
Merchants *StringConditionField `json:"merchants,omitempty"`
OrderType *StringConditionField `json:"order_type,omitempty"`
PickupPartnerLocationIds *StringConditionField `json:"pickup_partner_location_ids,omitempty"`
PickupV2 *GeographyConditionField `json:"pickup_v2,omitempty"`
RuleId *string `json:"rule_id,omitempty"`
RuleName *string `json:"rule_name,omitempty"`
RuleSetId *string `json:"rule_set_id,omitempty"`
Sequence *float32 `json:"sequence,omitempty"`
SourceType *StringConditionField `json:"source_type,omitempty"`
StartTime *float32 `json:"start_time,omitempty"`
Status *StatusField `json:"status,omitempty"`
Tenant *string `json:"tenant,omitempty"`
UpdateDate *time.Time `json:"update_date,omitempty"`
VolumetricWeight *NumberAreaConditionField `json:"volumetric_weight,omitempty"`
}
ServiceLevelRuleResponse defines model for service-level-rule-response.
type ServiceLevelRuleResponseConfigType ¶
type ServiceLevelRuleResponseConfigType string
ServiceLevelRuleResponseConfigType defines model for ServiceLevelRuleResponse.ConfigType.
const ( ServiceLevelRuleResponseConfigTypeDELIVERY ServiceLevelRuleResponseConfigType = "DELIVERY" ServiceLevelRuleResponseConfigTypeFULFILLMENT ServiceLevelRuleResponseConfigType = "FULFILLMENT" ServiceLevelRuleResponseConfigTypePROMISED ServiceLevelRuleResponseConfigType = "PROMISED" ServiceLevelRuleResponseConfigTypeSHIPPING ServiceLevelRuleResponseConfigType = "SHIPPING" )
Defines values for ServiceLevelRuleResponseConfigType.
type ServiceLevelRulesetWithRulesRequest ¶
type ServiceLevelRulesetWithRulesRequest struct {
AutomationRuleSet RulesetRequest `json:"automation_rule_set"`
AutomationRules *[]ServiceLevelRuleRequest `json:"automation_rules,omitempty"`
}
ServiceLevelRulesetWithRulesRequest defines model for service-level-ruleset-with-rules-request.
type ServiceLevelRulesetWithRulesResponse ¶
type ServiceLevelRulesetWithRulesResponse struct {
AutomationRuleSet RulesetResponse `json:"automation_rule_set"`
AutomationRules *[]ServiceLevelRuleResponse `json:"automation_rules,omitempty"`
}
ServiceLevelRulesetWithRulesResponse defines model for service-level-ruleset-with-rules-response.
type ShipManifestParams ¶
type ShipManifestParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
ShipManifestParams defines parameters for ShipManifest.
type ShipManifestResponse ¶
type ShipManifestResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
}
func ParseShipManifestResponse ¶
func ParseShipManifestResponse(rsp *http.Response) (*ShipManifestResponse, error)
ParseShipManifestResponse parses an HTTP response from a ShipManifestWithResponse call
func (ShipManifestResponse) Status ¶
func (r ShipManifestResponse) Status() string
Status returns HTTPResponse.Status
func (ShipManifestResponse) StatusCode ¶
func (r ShipManifestResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ShipmentDraftRequest ¶
type ShipmentDraftRequest struct {
// CarrierAccount Carrier account chosen for the shipment. Should contain either the carrier account id or carrier account name. Carrier account id takes precedence if both fields are passed.
CarrierAccount *CarrierAccountRequest `json:"carrier_account,omitempty"`
// Collection Collection details chosen for the shipment, such as scheduled collection date.
//
// It can be set using one of the following options
//
// Option 1: Provide the `scheduled_from` and `scheduled_to` to choose the scheduled date along with start and end time.
//
// Example:
// "collection": {
// "scheduled_from": "2022-01-01'T'10:00:00.000+1:00",
// "scheduled_to": "2022-01-01'T'12:00:00.000+1:00"
// }
//
// Option 2: Provide the `scheduled_date` only to choose the entire day.
//
// Example:
// "collection": {
// "scheduled_date": "2022-01-01"
// }
Collection *CollectionRequest `json:"collection,omitempty"`
// CustomAttributes Custom attributes in the form of a map:
// “`
// {"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}
// “`
// Please Note: You can only use custom attributes if you are subscribed to this feature.
CustomAttributes *CustomAttributes `json:"custom_attributes,omitempty"`
// Customs Customs declaration details such as total declared value.
Customs *CustomsObject `json:"customs,omitempty"`
// Delivery The delivery options chosen for the shipment, including the delivery type and schedule.
//
// It can be set using one of the following options
//
// Option 1: Provide the `scheduled_from` and `scheduled_to` to choose the scheduled date along with start and end time.
//
// Example:
// "delivery": {
// "delivery_type": "STANDARD",
// "scheduled_from": "2022-01-01'T'10:00:00.000+1:00",
// "scheduled_to": "2022-01-01'T'12:00:00.000+1:00"
// }
//
// Option 2: Provide the `scheduled_date` only to choose the entire day.
//
// Example:
// "delivery": {
// "delivery_type": "STANDARD",
// "scheduled_date": "2022-01-01"
// }
Delivery *DeliveryRequest `json:"delivery,omitempty"`
// Dropoff Dropoff address for the shipment. You can either pass a free-form address or a predefined location.
//
// For forward shipments, you can pass the customer's dropoff address as a free-form address.
//
// For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
Dropoff *ShipmentDraftRequest_Dropoff `json:"dropoff,omitempty"`
EntityType *ShipmentDraftRequestEntityType `json:"entity_type,omitempty"`
// Freight List of packages of type pallet or carton in a B2B shipment.
Freight *struct {
Packages *[]PackageObject `json:"packages,omitempty"`
} `json:"freight,omitempty"`
// Items List of individual items or SKUs in a shipment.
Items *[]ItemRequest `json:"items,omitempty"`
// Language Two letter ISO 639-1 code. Example: en
Language *string `json:"language,omitempty"`
// Merchant Merchant ID is mandatory to create a shipment
Merchant string `json:"merchant"`
// OrderDate Date-time in ISO 8601 format.
//
// Example: 2020-09-03T17:07:05.000+1:00 represents the date-time in UTC+1 time zone or 2020-09-03T17:07:05.000Z represents date-time in UTC (zulu) time zone
OrderDate *time.Time `json:"order_date,omitempty"`
// OrderType Pass one of the order types you have predefined in Carriyo
OrderType *string `json:"order_type,omitempty"`
// Parcels List of parcels in a B2C shipment.
Parcels *[]ParcelRequest `json:"parcels,omitempty"`
// Payment Payment details including the total value of the shipment and any pending Cash on Delivery amount.
Payment *PaymentRequest `json:"payment,omitempty"`
// Pickup Pickup address for the shipment. You can either pass a free-form address or a predefined location.
//
// For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
//
// For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
Pickup *ShipmentDraftRequest_Pickup `json:"pickup,omitempty"`
// References References for a shipment, provided by the merchant.
//
// The `partner_order_reference` is mandatory but not required to be unique. It is usually the customer facing order number.
//
// The `partner_shipment_reference` must be unique for every shipment. It is mandatory, but is copied from `partner_order_reference` if it is not provided.
//
// If a single order has multiple shipments, then they will share the `partner_order_reference` but have unique `partner_shipment_reference`.
References ReferencesRequest `json:"references"`
}
ShipmentDraftRequest defines model for shipment-draft-request.
type ShipmentDraftRequestEntityType ¶
type ShipmentDraftRequestEntityType string
ShipmentDraftRequestEntityType defines model for ShipmentDraftRequest.EntityType.
const ( ShipmentDraftRequestEntityTypeFORWARD ShipmentDraftRequestEntityType = "FORWARD" ShipmentDraftRequestEntityTypeREVERSE ShipmentDraftRequestEntityType = "REVERSE" )
Defines values for ShipmentDraftRequestEntityType.
type ShipmentDraftRequest_Dropoff ¶
type ShipmentDraftRequest_Dropoff struct {
// contains filtered or unexported fields
}
ShipmentDraftRequest_Dropoff Dropoff address for the shipment. You can either pass a free-form address or a predefined location.
For forward shipments, you can pass the customer's dropoff address as a free-form address.
For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
func (ShipmentDraftRequest_Dropoff) AsFreeFormRequest ¶
func (t ShipmentDraftRequest_Dropoff) AsFreeFormRequest() (FreeFormRequest, error)
AsFreeFormRequest returns the union data inside the ShipmentDraftRequest_Dropoff as a FreeFormRequest
func (ShipmentDraftRequest_Dropoff) AsLocationRequest ¶
func (t ShipmentDraftRequest_Dropoff) AsLocationRequest() (LocationRequest, error)
AsLocationRequest returns the union data inside the ShipmentDraftRequest_Dropoff as a LocationRequest
func (*ShipmentDraftRequest_Dropoff) FromFreeFormRequest ¶
func (t *ShipmentDraftRequest_Dropoff) FromFreeFormRequest(v FreeFormRequest) error
FromFreeFormRequest overwrites any union data inside the ShipmentDraftRequest_Dropoff as the provided FreeFormRequest
func (*ShipmentDraftRequest_Dropoff) FromLocationRequest ¶
func (t *ShipmentDraftRequest_Dropoff) FromLocationRequest(v LocationRequest) error
FromLocationRequest overwrites any union data inside the ShipmentDraftRequest_Dropoff as the provided LocationRequest
func (ShipmentDraftRequest_Dropoff) MarshalJSON ¶
func (t ShipmentDraftRequest_Dropoff) MarshalJSON() ([]byte, error)
func (*ShipmentDraftRequest_Dropoff) MergeFreeFormRequest ¶
func (t *ShipmentDraftRequest_Dropoff) MergeFreeFormRequest(v FreeFormRequest) error
MergeFreeFormRequest performs a merge with any union data inside the ShipmentDraftRequest_Dropoff, using the provided FreeFormRequest
func (*ShipmentDraftRequest_Dropoff) MergeLocationRequest ¶
func (t *ShipmentDraftRequest_Dropoff) MergeLocationRequest(v LocationRequest) error
MergeLocationRequest performs a merge with any union data inside the ShipmentDraftRequest_Dropoff, using the provided LocationRequest
func (*ShipmentDraftRequest_Dropoff) UnmarshalJSON ¶
func (t *ShipmentDraftRequest_Dropoff) UnmarshalJSON(b []byte) error
type ShipmentDraftRequest_Pickup ¶
type ShipmentDraftRequest_Pickup struct {
// contains filtered or unexported fields
}
ShipmentDraftRequest_Pickup Pickup address for the shipment. You can either pass a free-form address or a predefined location.
For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
func (ShipmentDraftRequest_Pickup) AsFreeFormRequest ¶
func (t ShipmentDraftRequest_Pickup) AsFreeFormRequest() (FreeFormRequest, error)
AsFreeFormRequest returns the union data inside the ShipmentDraftRequest_Pickup as a FreeFormRequest
func (ShipmentDraftRequest_Pickup) AsLocationRequest ¶
func (t ShipmentDraftRequest_Pickup) AsLocationRequest() (LocationRequest, error)
AsLocationRequest returns the union data inside the ShipmentDraftRequest_Pickup as a LocationRequest
func (*ShipmentDraftRequest_Pickup) FromFreeFormRequest ¶
func (t *ShipmentDraftRequest_Pickup) FromFreeFormRequest(v FreeFormRequest) error
FromFreeFormRequest overwrites any union data inside the ShipmentDraftRequest_Pickup as the provided FreeFormRequest
func (*ShipmentDraftRequest_Pickup) FromLocationRequest ¶
func (t *ShipmentDraftRequest_Pickup) FromLocationRequest(v LocationRequest) error
FromLocationRequest overwrites any union data inside the ShipmentDraftRequest_Pickup as the provided LocationRequest
func (ShipmentDraftRequest_Pickup) MarshalJSON ¶
func (t ShipmentDraftRequest_Pickup) MarshalJSON() ([]byte, error)
func (*ShipmentDraftRequest_Pickup) MergeFreeFormRequest ¶
func (t *ShipmentDraftRequest_Pickup) MergeFreeFormRequest(v FreeFormRequest) error
MergeFreeFormRequest performs a merge with any union data inside the ShipmentDraftRequest_Pickup, using the provided FreeFormRequest
func (*ShipmentDraftRequest_Pickup) MergeLocationRequest ¶
func (t *ShipmentDraftRequest_Pickup) MergeLocationRequest(v LocationRequest) error
MergeLocationRequest performs a merge with any union data inside the ShipmentDraftRequest_Pickup, using the provided LocationRequest
func (*ShipmentDraftRequest_Pickup) UnmarshalJSON ¶
func (t *ShipmentDraftRequest_Pickup) UnmarshalJSON(b []byte) error
type ShipmentObject ¶
type ShipmentObject struct {
// CarrierAccount Carrier account chosen for the shipment.
CarrierAccount *CarrierAccountObject `json:"carrier_account,omitempty"`
// Collection Collection details chosen for the shipment, such as scheduled collection date.
Collection *CollectionObject `json:"collection,omitempty"`
// ConfirmationDate The date the shipment was confirmed for booking
ConfirmationDate *time.Time `json:"confirmation_date,omitempty"`
// CreationDate The date the shipment was created in Carriyo
CreationDate *time.Time `json:"creation_date,omitempty"`
// CustomAttributes Additional custom attributes provided by the merchant.
CustomAttributes *map[string]interface{} `json:"custom_attributes,omitempty"`
// Customs Customs declaration details such as total declared value.
Customs *CustomsObject `json:"customs,omitempty"`
// Delivery Delivery details chosen for the shipment, such as chosen delivery type and scheduled delivery date.
Delivery *DeliveryObject `json:"delivery,omitempty"`
// Dropoff Either a free-form address or a predefined location.
Dropoff *LocationObject `json:"dropoff,omitempty"`
// EntityType The type of the shipment is either FORWARD or REVERSE
EntityType *ShipmentObjectEntityType `json:"entity_type,omitempty"`
// EstimatedProcessDate The date the shipment is expected to be processed in ISO 8601 format. Example: 2022-03-01T17:07:05.000Z
EstimatedProcessDate *time.Time `json:"estimated_process_date,omitempty"`
// EstimatedShippingCost The estimated cost of the shipping based either on the costing profile you have configured for the carrier or carrier costing API response
EstimatedShippingCost *EstimatedShippingCost `json:"estimated_shipping_cost,omitempty"`
// Freight List of packages of type pallet or carton in a B2B shipment.
Freight *struct {
Packages *[]PackageObject `json:"packages,omitempty"`
} `json:"freight,omitempty"`
// Items List of individual items or SKUs in a shipment.
Items *[]ItemObject `json:"items,omitempty"`
// Language Two letter ISO 639-1 code. Example: en
Language *string `json:"language,omitempty"`
// Merchant ID of the merchant that created this shipment
Merchant *string `json:"merchant,omitempty"`
// OrderDate The date the customer order was received by the merchant
OrderDate *time.Time `json:"order_date,omitempty"`
// OrderType The type of the order. The possible values can be one of the order types predefined by the merchant.
OrderType *string `json:"order_type,omitempty"`
// OriginalPromisedDeliveryDate The original promised delivery date for the shipment in ISO 8601 format (if the promise is updated). Example: 2022-03-01T17:07:05.000Z
OriginalPromisedDeliveryDate *time.Time `json:"original_promised_delivery_date,omitempty"`
// Parcels List of parcels in a B2C shipment.
Parcels *[]ParcelObject `json:"parcels,omitempty"`
// Payment Payment details including the total value of the shipment and any pending Cash on Delivery amount.
Payment *PaymentObject `json:"payment,omitempty"`
// Pickup Either a free-form address or a predefined location.
Pickup *LocationObject `json:"pickup,omitempty"`
// PostShippingInfo Booking details such as tracking number, labels etc.
PostShippingInfo *PostShippingInfo `json:"post_shipping_info,omitempty"`
// PromisedDeliveryDate The promised delivery date for the shipment in ISO 8601 format. Example: 2022-03-01T17:07:05.000Z
PromisedDeliveryDate *time.Time `json:"promised_delivery_date,omitempty"`
// References References for a shipment, provided by the merchant.
References *ReferencesObject `json:"references,omitempty"`
// ReturnRequestId ID of the Return request that initiated the reverse shipment
ReturnRequestId *string `json:"return_request_id,omitempty"`
// ShipmentId Unique identifier for the shipment
ShipmentId *string `json:"shipment_id,omitempty"`
// UpdateDate The date the shipment was last updated in Carriyo
UpdateDate *time.Time `json:"update_date,omitempty"`
}
ShipmentObject defines model for shipment-object.
type ShipmentObjectEntityType ¶
type ShipmentObjectEntityType string
ShipmentObjectEntityType The type of the shipment is either FORWARD or REVERSE
const ( ShipmentObjectEntityTypeFORWARD ShipmentObjectEntityType = "FORWARD" ShipmentObjectEntityTypeREVERSE ShipmentObjectEntityType = "REVERSE" )
Defines values for ShipmentObjectEntityType.
type ShipmentPatchRequest ¶
type ShipmentPatchRequest struct {
// CarrierAccount Carrier account chosen for the shipment. Should contain either the carrier account id or carrier account name. Carrier account id takes precedence if both fields are passed.
CarrierAccount *CarrierAccountRequest `json:"carrier_account,omitempty"`
// Collection Collection details chosen for the shipment, such as scheduled collection date.
//
// It can be set using one of the following options
//
// Option 1: Provide the `scheduled_from` and `scheduled_to` to choose the scheduled date along with start and end time.
//
// Example:
// "collection": {
// "scheduled_from": "2022-01-01'T'10:00:00.000+1:00",
// "scheduled_to": "2022-01-01'T'12:00:00.000+1:00"
// }
//
// Option 2: Provide the `scheduled_date` only to choose the entire day.
//
// Example:
// "collection": {
// "scheduled_date": "2022-01-01"
// }
Collection *CollectionRequest `json:"collection,omitempty"`
// CustomAttributes Custom attributes in the form of a map:
// “`
// {"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}
// “`
// Please Note: You can only use custom attributes if you are subscribed to this feature.
CustomAttributes *CustomAttributes `json:"custom_attributes,omitempty"`
// Customs Customs declaration details such as total declared value.
Customs *CustomsObject `json:"customs,omitempty"`
// Delivery The delivery options chosen for the shipment, including the delivery type and schedule.
//
// It can be set using one of the following options
//
// Option 1: Provide the `scheduled_from` and `scheduled_to` to choose the scheduled date along with start and end time.
//
// Example:
// "delivery": {
// "delivery_type": "STANDARD",
// "scheduled_from": "2022-01-01'T'10:00:00.000+1:00",
// "scheduled_to": "2022-01-01'T'12:00:00.000+1:00"
// }
//
// Option 2: Provide the `scheduled_date` only to choose the entire day.
//
// Example:
// "delivery": {
// "delivery_type": "STANDARD",
// "scheduled_date": "2022-01-01"
// }
Delivery *DeliveryRequest `json:"delivery,omitempty"`
// Dropoff Dropoff address for the shipment. You can either pass a free-form address or a predefined location.
//
// For forward shipments, you can pass the customer's dropoff address as a free-form address.
//
// For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) defined when you created the location in Carriyo.
Dropoff *ShipmentPatchRequest_Dropoff `json:"dropoff,omitempty"`
// Freight List of packages of type pallet or carton in a B2B shipment.
Freight *struct {
Packages *[]PackageObject `json:"packages,omitempty"`
} `json:"freight,omitempty"`
// Items List of individual items or SKUs in a shipment.
Items *[]ItemRequest `json:"items,omitempty"`
OrderDate *time.Time `json:"order_date,omitempty"`
// OrderType Pass one of the order types you have predefined in Carriyo
OrderType *string `json:"order_type,omitempty"`
// Parcels List of parcels in a B2C shipment.
Parcels *[]ParcelRequest `json:"parcels,omitempty"`
// Payment Payment details including the total value of the shipment and any pending Cash on Delivery amount.
Payment *PaymentRequest `json:"payment,omitempty"`
// Pickup Pickup address for the shipment. You can either pass a free-form address or a predefined location.
//
// For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) defined when you created the location in Carriyo.
//
// For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
Pickup *ShipmentPatchRequest_Pickup `json:"pickup,omitempty"`
}
ShipmentPatchRequest defines model for shipment-patch-request.
type ShipmentPatchRequest_Dropoff ¶
type ShipmentPatchRequest_Dropoff struct {
// contains filtered or unexported fields
}
ShipmentPatchRequest_Dropoff Dropoff address for the shipment. You can either pass a free-form address or a predefined location.
For forward shipments, you can pass the customer's dropoff address as a free-form address.
For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) defined when you created the location in Carriyo.
func (ShipmentPatchRequest_Dropoff) AsFreeFormRequest ¶
func (t ShipmentPatchRequest_Dropoff) AsFreeFormRequest() (FreeFormRequest, error)
AsFreeFormRequest returns the union data inside the ShipmentPatchRequest_Dropoff as a FreeFormRequest
func (ShipmentPatchRequest_Dropoff) AsLocationRequest ¶
func (t ShipmentPatchRequest_Dropoff) AsLocationRequest() (LocationRequest, error)
AsLocationRequest returns the union data inside the ShipmentPatchRequest_Dropoff as a LocationRequest
func (*ShipmentPatchRequest_Dropoff) FromFreeFormRequest ¶
func (t *ShipmentPatchRequest_Dropoff) FromFreeFormRequest(v FreeFormRequest) error
FromFreeFormRequest overwrites any union data inside the ShipmentPatchRequest_Dropoff as the provided FreeFormRequest
func (*ShipmentPatchRequest_Dropoff) FromLocationRequest ¶
func (t *ShipmentPatchRequest_Dropoff) FromLocationRequest(v LocationRequest) error
FromLocationRequest overwrites any union data inside the ShipmentPatchRequest_Dropoff as the provided LocationRequest
func (ShipmentPatchRequest_Dropoff) MarshalJSON ¶
func (t ShipmentPatchRequest_Dropoff) MarshalJSON() ([]byte, error)
func (*ShipmentPatchRequest_Dropoff) MergeFreeFormRequest ¶
func (t *ShipmentPatchRequest_Dropoff) MergeFreeFormRequest(v FreeFormRequest) error
MergeFreeFormRequest performs a merge with any union data inside the ShipmentPatchRequest_Dropoff, using the provided FreeFormRequest
func (*ShipmentPatchRequest_Dropoff) MergeLocationRequest ¶
func (t *ShipmentPatchRequest_Dropoff) MergeLocationRequest(v LocationRequest) error
MergeLocationRequest performs a merge with any union data inside the ShipmentPatchRequest_Dropoff, using the provided LocationRequest
func (*ShipmentPatchRequest_Dropoff) UnmarshalJSON ¶
func (t *ShipmentPatchRequest_Dropoff) UnmarshalJSON(b []byte) error
type ShipmentPatchRequest_Pickup ¶
type ShipmentPatchRequest_Pickup struct {
// contains filtered or unexported fields
}
ShipmentPatchRequest_Pickup Pickup address for the shipment. You can either pass a free-form address or a predefined location.
For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) defined when you created the location in Carriyo.
For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
func (ShipmentPatchRequest_Pickup) AsFreeFormRequest ¶
func (t ShipmentPatchRequest_Pickup) AsFreeFormRequest() (FreeFormRequest, error)
AsFreeFormRequest returns the union data inside the ShipmentPatchRequest_Pickup as a FreeFormRequest
func (ShipmentPatchRequest_Pickup) AsLocationRequest ¶
func (t ShipmentPatchRequest_Pickup) AsLocationRequest() (LocationRequest, error)
AsLocationRequest returns the union data inside the ShipmentPatchRequest_Pickup as a LocationRequest
func (*ShipmentPatchRequest_Pickup) FromFreeFormRequest ¶
func (t *ShipmentPatchRequest_Pickup) FromFreeFormRequest(v FreeFormRequest) error
FromFreeFormRequest overwrites any union data inside the ShipmentPatchRequest_Pickup as the provided FreeFormRequest
func (*ShipmentPatchRequest_Pickup) FromLocationRequest ¶
func (t *ShipmentPatchRequest_Pickup) FromLocationRequest(v LocationRequest) error
FromLocationRequest overwrites any union data inside the ShipmentPatchRequest_Pickup as the provided LocationRequest
func (ShipmentPatchRequest_Pickup) MarshalJSON ¶
func (t ShipmentPatchRequest_Pickup) MarshalJSON() ([]byte, error)
func (*ShipmentPatchRequest_Pickup) MergeFreeFormRequest ¶
func (t *ShipmentPatchRequest_Pickup) MergeFreeFormRequest(v FreeFormRequest) error
MergeFreeFormRequest performs a merge with any union data inside the ShipmentPatchRequest_Pickup, using the provided FreeFormRequest
func (*ShipmentPatchRequest_Pickup) MergeLocationRequest ¶
func (t *ShipmentPatchRequest_Pickup) MergeLocationRequest(v LocationRequest) error
MergeLocationRequest performs a merge with any union data inside the ShipmentPatchRequest_Pickup, using the provided LocationRequest
func (*ShipmentPatchRequest_Pickup) UnmarshalJSON ¶
func (t *ShipmentPatchRequest_Pickup) UnmarshalJSON(b []byte) error
type ShipmentRequest ¶
type ShipmentRequest struct {
// CarrierAccount Carrier account chosen for the shipment. Should contain either the carrier account id or carrier account name. Carrier account id takes precedence if both fields are passed.
CarrierAccount *CarrierAccountRequest `json:"carrier_account,omitempty"`
// Collection Collection details chosen for the shipment, such as scheduled collection date.
//
// It can be set using one of the following options
//
// Option 1: Provide the `scheduled_from` and `scheduled_to` to choose the scheduled date along with start and end time.
//
// Example:
// "collection": {
// "scheduled_from": "2022-01-01'T'10:00:00.000+1:00",
// "scheduled_to": "2022-01-01'T'12:00:00.000+1:00"
// }
//
// Option 2: Provide the `scheduled_date` only to choose the entire day.
//
// Example:
// "collection": {
// "scheduled_date": "2022-01-01"
// }
Collection *CollectionRequest `json:"collection,omitempty"`
// CustomAttributes Custom attributes in the form of a map:
// “`
// {"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}
// “`
// Please Note: You can only use custom attributes if you are subscribed to this feature.
CustomAttributes *CustomAttributes `json:"custom_attributes,omitempty"`
// Customs Customs declaration details such as total declared value.
Customs *CustomsObject `json:"customs,omitempty"`
// Delivery The delivery options chosen for the shipment, including the delivery type and schedule.
//
// It can be set using one of the following options
//
// Option 1: Provide the `scheduled_from` and `scheduled_to` to choose the scheduled date along with start and end time.
//
// Example:
// "delivery": {
// "delivery_type": "STANDARD",
// "scheduled_from": "2022-01-01'T'10:00:00.000+1:00",
// "scheduled_to": "2022-01-01'T'12:00:00.000+1:00"
// }
//
// Option 2: Provide the `scheduled_date` only to choose the entire day.
//
// Example:
// "delivery": {
// "delivery_type": "STANDARD",
// "scheduled_date": "2022-01-01"
// }
Delivery *DeliveryRequest `json:"delivery,omitempty"`
// Dropoff Dropoff address for the shipment. You can either pass a free-form address or a predefined location.
//
// For forward shipments, you can pass the customer's dropoff address as a free-form address.
//
// For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
Dropoff ShipmentRequest_Dropoff `json:"dropoff"`
EntityType *ShipmentRequestEntityType `json:"entity_type,omitempty"`
// Freight List of packages of type pallet or carton in a B2B shipment.
Freight *struct {
Packages *[]PackageObject `json:"packages,omitempty"`
} `json:"freight,omitempty"`
// Items List of individual items or SKUs in a shipment.
Items []ItemRequest `json:"items"`
// Language Two letter ISO 639-1 code. Example: en
Language *string `json:"language,omitempty"`
// Merchant Merchant ID is mandatory to create a shipment
Merchant string `json:"merchant"`
// OrderDate Date-time in ISO 8601 format.
//
// Example: 2020-09-03T17:07:05.000+1:00 represents the date-time in UTC+1 time zone or 2020-09-03T17:07:05.000Z represents date-time in UTC (zulu) time zone
OrderDate *time.Time `json:"order_date,omitempty"`
// OrderType Pass one of the order types you have predefined in Carriyo
OrderType *string `json:"order_type,omitempty"`
// Parcels List of parcels in a B2C shipment.
Parcels *[]ParcelRequest `json:"parcels,omitempty"`
// Payment Payment details including the total value of the shipment and any pending Cash on Delivery amount.
Payment PaymentRequest `json:"payment"`
// Pickup Pickup address for the shipment. You can either pass a free-form address or a predefined location.
//
// For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
//
// For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
Pickup ShipmentRequest_Pickup `json:"pickup"`
// References References for a shipment, provided by the merchant.
//
// The `partner_order_reference` is mandatory but not required to be unique. It is usually the customer facing order number.
//
// The `partner_shipment_reference` must be unique for every shipment. It is mandatory, but is copied from `partner_order_reference` if it is not provided.
//
// If a single order has multiple shipments, then they will share the `partner_order_reference` but have unique `partner_shipment_reference`.
References ReferencesRequest `json:"references"`
}
ShipmentRequest defines model for shipment-request.
type ShipmentRequestEntityType ¶
type ShipmentRequestEntityType string
ShipmentRequestEntityType defines model for ShipmentRequest.EntityType.
const ( ShipmentRequestEntityTypeFORWARD ShipmentRequestEntityType = "FORWARD" ShipmentRequestEntityTypeREVERSE ShipmentRequestEntityType = "REVERSE" )
Defines values for ShipmentRequestEntityType.
type ShipmentRequest_Dropoff ¶
type ShipmentRequest_Dropoff struct {
// contains filtered or unexported fields
}
ShipmentRequest_Dropoff Dropoff address for the shipment. You can either pass a free-form address or a predefined location.
For forward shipments, you can pass the customer's dropoff address as a free-form address.
For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
func (ShipmentRequest_Dropoff) AsFreeFormRequest ¶
func (t ShipmentRequest_Dropoff) AsFreeFormRequest() (FreeFormRequest, error)
AsFreeFormRequest returns the union data inside the ShipmentRequest_Dropoff as a FreeFormRequest
func (ShipmentRequest_Dropoff) AsLocationRequest ¶
func (t ShipmentRequest_Dropoff) AsLocationRequest() (LocationRequest, error)
AsLocationRequest returns the union data inside the ShipmentRequest_Dropoff as a LocationRequest
func (*ShipmentRequest_Dropoff) FromFreeFormRequest ¶
func (t *ShipmentRequest_Dropoff) FromFreeFormRequest(v FreeFormRequest) error
FromFreeFormRequest overwrites any union data inside the ShipmentRequest_Dropoff as the provided FreeFormRequest
func (*ShipmentRequest_Dropoff) FromLocationRequest ¶
func (t *ShipmentRequest_Dropoff) FromLocationRequest(v LocationRequest) error
FromLocationRequest overwrites any union data inside the ShipmentRequest_Dropoff as the provided LocationRequest
func (ShipmentRequest_Dropoff) MarshalJSON ¶
func (t ShipmentRequest_Dropoff) MarshalJSON() ([]byte, error)
func (*ShipmentRequest_Dropoff) MergeFreeFormRequest ¶
func (t *ShipmentRequest_Dropoff) MergeFreeFormRequest(v FreeFormRequest) error
MergeFreeFormRequest performs a merge with any union data inside the ShipmentRequest_Dropoff, using the provided FreeFormRequest
func (*ShipmentRequest_Dropoff) MergeLocationRequest ¶
func (t *ShipmentRequest_Dropoff) MergeLocationRequest(v LocationRequest) error
MergeLocationRequest performs a merge with any union data inside the ShipmentRequest_Dropoff, using the provided LocationRequest
func (*ShipmentRequest_Dropoff) UnmarshalJSON ¶
func (t *ShipmentRequest_Dropoff) UnmarshalJSON(b []byte) error
type ShipmentRequest_Pickup ¶
type ShipmentRequest_Pickup struct {
// contains filtered or unexported fields
}
ShipmentRequest_Pickup Pickup address for the shipment. You can either pass a free-form address or a predefined location.
For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
func (ShipmentRequest_Pickup) AsFreeFormRequest ¶
func (t ShipmentRequest_Pickup) AsFreeFormRequest() (FreeFormRequest, error)
AsFreeFormRequest returns the union data inside the ShipmentRequest_Pickup as a FreeFormRequest
func (ShipmentRequest_Pickup) AsLocationRequest ¶
func (t ShipmentRequest_Pickup) AsLocationRequest() (LocationRequest, error)
AsLocationRequest returns the union data inside the ShipmentRequest_Pickup as a LocationRequest
func (*ShipmentRequest_Pickup) FromFreeFormRequest ¶
func (t *ShipmentRequest_Pickup) FromFreeFormRequest(v FreeFormRequest) error
FromFreeFormRequest overwrites any union data inside the ShipmentRequest_Pickup as the provided FreeFormRequest
func (*ShipmentRequest_Pickup) FromLocationRequest ¶
func (t *ShipmentRequest_Pickup) FromLocationRequest(v LocationRequest) error
FromLocationRequest overwrites any union data inside the ShipmentRequest_Pickup as the provided LocationRequest
func (ShipmentRequest_Pickup) MarshalJSON ¶
func (t ShipmentRequest_Pickup) MarshalJSON() ([]byte, error)
func (*ShipmentRequest_Pickup) MergeFreeFormRequest ¶
func (t *ShipmentRequest_Pickup) MergeFreeFormRequest(v FreeFormRequest) error
MergeFreeFormRequest performs a merge with any union data inside the ShipmentRequest_Pickup, using the provided FreeFormRequest
func (*ShipmentRequest_Pickup) MergeLocationRequest ¶
func (t *ShipmentRequest_Pickup) MergeLocationRequest(v LocationRequest) error
MergeLocationRequest performs a merge with any union data inside the ShipmentRequest_Pickup, using the provided LocationRequest
func (*ShipmentRequest_Pickup) UnmarshalJSON ¶
func (t *ShipmentRequest_Pickup) UnmarshalJSON(b []byte) error
type ShippingRate ¶
type ShippingRate struct {
Carrier *string `json:"carrier,omitempty"`
CarrierAccountId *string `json:"carrier_account_id,omitempty"`
CarrierAccountName *string `json:"carrier_account_name,omitempty"`
DeliveryPromise *string `json:"delivery_promise,omitempty"`
ErrorDetails *[]ErrorDetail `json:"error_details,omitempty"`
EstimatedDays *int `json:"estimated_days,omitempty"`
// EstimatedShippingCost The estimated cost of the shipping based either on the costing profile you have configured for the carrier or carrier costing API response
EstimatedShippingCost *EstimatedShippingCost `json:"estimated_shipping_cost,omitempty"`
ServiceDescription *string `json:"service_description,omitempty"`
ServiceName *string `json:"service_name,omitempty"`
}
ShippingRate Shipping Rate based on either the costing profile you have configured for the carrier or carrier costing api response
type ShippingRateItemRequest ¶
type ShippingRateItemRequest struct {
// Cost The unit cost of the item
Cost *struct {
Amount float32 `json:"amount"`
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency string `json:"currency"`
} `json:"cost,omitempty"`
// DangerousGoods If the item is classified as dangerous goods. Usually required for cross-border shipping.
DangerousGoods *bool `json:"dangerous_goods,omitempty"`
// HsCode HS Code of the item. Usually required for cross-border shipping.
HsCode *string `json:"hs_code,omitempty"`
// OriginCountry Country of origin of the item. Usually required for cross-border shipping.
OriginCountry *string `json:"origin_country,omitempty"`
// Price The unit price of the item
Price *struct {
Amount float32 `json:"amount"`
// Currency The three-letter currency code (ISO 4217) for the amount. e.g., USD
Currency string `json:"currency"`
} `json:"price,omitempty"`
Quantity *int `json:"quantity,omitempty"`
// Sku SKU ID of the item. Only required when you are passing parcel_items in the parcel.
Sku *string `json:"sku,omitempty"`
// Weight The weight of the item
Weight *struct {
// Unit Default weight unit is `kg` if not provided.
Unit *ShippingRateItemRequestWeightUnit `json:"unit,omitempty"`
Value *float32 `json:"value,omitempty"`
} `json:"weight,omitempty"`
}
ShippingRateItemRequest defines model for shipping-rate-item-request.
type ShippingRateItemRequestWeightUnit ¶
type ShippingRateItemRequestWeightUnit string
ShippingRateItemRequestWeightUnit Default weight unit is `kg` if not provided.
const (
ShippingRateItemRequestWeightUnitKg ShippingRateItemRequestWeightUnit = "kg"
)
Defines values for ShippingRateItemRequestWeightUnit.
type ShippingRateLocationRequest ¶
type ShippingRateLocationRequest struct {
// AddressCodes Array of location codes for the address
AddressCodes *[]AddressCode `json:"address_codes,omitempty"`
// Area District, suburb or neighbourhood, represented by the Carriyo Area Code if known. If not, it's a free text.
//
// Please use the Carriyo standard Area Code when available, to ensure that Carriyo can map this information correctly to the carrier.
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
Area *string `json:"area,omitempty"`
// City City, town, or village, represented by the Carriyo City Code if known. If not, it's a free text.
//
// Please use the Carriyo standard City Code when available, to ensure that Carriyo can map this information correctly to the carrier.
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
City string `json:"city"`
// Coords Latitude and longitude (decimal degrees) of the address as an array. e.g., [25.19741, 55.27442]
Coords *[]float32 `json:"coords,omitempty"`
// Country Two-letter country code (ISO 3166-1 alpha-2).
Country string `json:"country"`
// LocationCodes Array of location codes for the address
LocationCodes *[]LocationCode `json:"location_codes,omitempty"`
// Postcode ZIP or postal code
Postcode *string `json:"postcode,omitempty"`
// State State, county, province, or region, represented by the Carriyo State Code if known. If not, it's a free text.
//
// **Note: The state is automatically set if a standard Carriyo city is passed.**
//
// [Please refer to the Carriyo Geo List for more information.](/guides/carriyo-geo-list)
State *string `json:"state,omitempty"`
}
ShippingRateLocationRequest Provide geography information
type ShippingRatePackageObject ¶
type ShippingRatePackageObject struct {
Dimension *Dimension `json:"dimension,omitempty"`
Type interface{} `json:"type,omitempty"`
Weight *Weight `json:"weight,omitempty"`
}
ShippingRatePackageObject List of packages of type pallet or carton in a B2B shipment.
type ShippingRateParcelRequest ¶
type ShippingRateParcelRequest struct {
Dimension *Dimension `json:"dimension,omitempty"`
ParcelItems *[]ParcelItem `json:"parcel_items,omitempty"`
Weight *Weight `json:"weight,omitempty"`
}
ShippingRateParcelRequest List of parcels in a B2C shipment.
type ShippingRatesRequest ¶
type ShippingRatesRequest struct {
// CarrierAccounts List of carrier accounts for which shipping rate is requested.
CarrierAccounts *[]CarrierAccountRequest `json:"carrier_accounts,omitempty"`
// Collection Collection details chosen for the shipment, such as scheduled collection date.
Collection *CollectionObject `json:"collection,omitempty"`
// CustomAttributes Custom attributes in the form of a map:
// “`
// {"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}
// “`
// Please Note: You can only use custom attributes if you are subscribed to this feature.
CustomAttributes *CustomAttributes `json:"custom_attributes,omitempty"`
// Customs Customs declaration details such as total declared value.
Customs *CustomsObject `json:"customs,omitempty"`
// Delivery Delivery details chosen for the shipment, such as chosen delivery type and scheduled delivery date.
Delivery *DeliveryObject `json:"delivery,omitempty"`
// Dropoff Dropoff address for the shipment. You can either pass a free-form address or a predefined location.
//
// For forward shipments, you can pass the customer's dropoff address as a free-form address.
//
// For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
Dropoff ShippingRatesRequest_Dropoff `json:"dropoff"`
EntityType *ShippingRatesRequestEntityType `json:"entity_type,omitempty"`
// Freight (One of parcels or freight required) List of packages of type pallet or carton in a B2B shipment.
Freight *struct {
Packages *[]ShippingRatePackageObject `json:"packages,omitempty"`
} `json:"freight,omitempty"`
// Items List of individual items or SKUs in a shipment.
Items *[]ShippingRateItemRequest `json:"items,omitempty"`
// Merchant ID of the merchant
Merchant *string `json:"merchant,omitempty"`
// Parcels (One of parcels or freight required) List of parcels in a B2C shipment.
Parcels []ShippingRateParcelRequest `json:"parcels"`
// Payment Payment details including the total value of the shipment and any pending Cash on Delivery amount.
Payment *PaymentRequest `json:"payment,omitempty"`
// Pickup Pickup address for the shipment. You can either pass a free-form address or a predefined location.
//
// For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
//
// For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
Pickup ShippingRatesRequest_Pickup `json:"pickup"`
}
ShippingRatesRequest This endpoint will return shipping rates based on either costing profile for that particular carrier or getting rates from the carrier real time.
type ShippingRatesRequestEntityType ¶
type ShippingRatesRequestEntityType string
ShippingRatesRequestEntityType defines model for ShippingRatesRequest.EntityType.
const ( ShippingRatesRequestEntityTypeFORWARD ShippingRatesRequestEntityType = "FORWARD" ShippingRatesRequestEntityTypeREVERSE ShippingRatesRequestEntityType = "REVERSE" )
Defines values for ShippingRatesRequestEntityType.
type ShippingRatesRequest_Dropoff ¶
type ShippingRatesRequest_Dropoff struct {
// contains filtered or unexported fields
}
ShippingRatesRequest_Dropoff Dropoff address for the shipment. You can either pass a free-form address or a predefined location.
For forward shipments, you can pass the customer's dropoff address as a free-form address.
For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
func (ShippingRatesRequest_Dropoff) AsLocationRequest ¶
func (t ShippingRatesRequest_Dropoff) AsLocationRequest() (LocationRequest, error)
AsLocationRequest returns the union data inside the ShippingRatesRequest_Dropoff as a LocationRequest
func (ShippingRatesRequest_Dropoff) AsShippingRateLocationRequest ¶
func (t ShippingRatesRequest_Dropoff) AsShippingRateLocationRequest() (ShippingRateLocationRequest, error)
AsShippingRateLocationRequest returns the union data inside the ShippingRatesRequest_Dropoff as a ShippingRateLocationRequest
func (*ShippingRatesRequest_Dropoff) FromLocationRequest ¶
func (t *ShippingRatesRequest_Dropoff) FromLocationRequest(v LocationRequest) error
FromLocationRequest overwrites any union data inside the ShippingRatesRequest_Dropoff as the provided LocationRequest
func (*ShippingRatesRequest_Dropoff) FromShippingRateLocationRequest ¶
func (t *ShippingRatesRequest_Dropoff) FromShippingRateLocationRequest(v ShippingRateLocationRequest) error
FromShippingRateLocationRequest overwrites any union data inside the ShippingRatesRequest_Dropoff as the provided ShippingRateLocationRequest
func (ShippingRatesRequest_Dropoff) MarshalJSON ¶
func (t ShippingRatesRequest_Dropoff) MarshalJSON() ([]byte, error)
func (*ShippingRatesRequest_Dropoff) MergeLocationRequest ¶
func (t *ShippingRatesRequest_Dropoff) MergeLocationRequest(v LocationRequest) error
MergeLocationRequest performs a merge with any union data inside the ShippingRatesRequest_Dropoff, using the provided LocationRequest
func (*ShippingRatesRequest_Dropoff) MergeShippingRateLocationRequest ¶
func (t *ShippingRatesRequest_Dropoff) MergeShippingRateLocationRequest(v ShippingRateLocationRequest) error
MergeShippingRateLocationRequest performs a merge with any union data inside the ShippingRatesRequest_Dropoff, using the provided ShippingRateLocationRequest
func (*ShippingRatesRequest_Dropoff) UnmarshalJSON ¶
func (t *ShippingRatesRequest_Dropoff) UnmarshalJSON(b []byte) error
type ShippingRatesRequest_Pickup ¶
type ShippingRatesRequest_Pickup struct {
// contains filtered or unexported fields
}
ShippingRatesRequest_Pickup Pickup address for the shipment. You can either pass a free-form address or a predefined location.
For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (`partner_location_id`), or your own location code (`partner_location_code`) as defined when you created the location in Carriyo.
For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
func (ShippingRatesRequest_Pickup) AsLocationRequest ¶
func (t ShippingRatesRequest_Pickup) AsLocationRequest() (LocationRequest, error)
AsLocationRequest returns the union data inside the ShippingRatesRequest_Pickup as a LocationRequest
func (ShippingRatesRequest_Pickup) AsShippingRateLocationRequest ¶
func (t ShippingRatesRequest_Pickup) AsShippingRateLocationRequest() (ShippingRateLocationRequest, error)
AsShippingRateLocationRequest returns the union data inside the ShippingRatesRequest_Pickup as a ShippingRateLocationRequest
func (*ShippingRatesRequest_Pickup) FromLocationRequest ¶
func (t *ShippingRatesRequest_Pickup) FromLocationRequest(v LocationRequest) error
FromLocationRequest overwrites any union data inside the ShippingRatesRequest_Pickup as the provided LocationRequest
func (*ShippingRatesRequest_Pickup) FromShippingRateLocationRequest ¶
func (t *ShippingRatesRequest_Pickup) FromShippingRateLocationRequest(v ShippingRateLocationRequest) error
FromShippingRateLocationRequest overwrites any union data inside the ShippingRatesRequest_Pickup as the provided ShippingRateLocationRequest
func (ShippingRatesRequest_Pickup) MarshalJSON ¶
func (t ShippingRatesRequest_Pickup) MarshalJSON() ([]byte, error)
func (*ShippingRatesRequest_Pickup) MergeLocationRequest ¶
func (t *ShippingRatesRequest_Pickup) MergeLocationRequest(v LocationRequest) error
MergeLocationRequest performs a merge with any union data inside the ShippingRatesRequest_Pickup, using the provided LocationRequest
func (*ShippingRatesRequest_Pickup) MergeShippingRateLocationRequest ¶
func (t *ShippingRatesRequest_Pickup) MergeShippingRateLocationRequest(v ShippingRateLocationRequest) error
MergeShippingRateLocationRequest performs a merge with any union data inside the ShippingRatesRequest_Pickup, using the provided ShippingRateLocationRequest
func (*ShippingRatesRequest_Pickup) UnmarshalJSON ¶
func (t *ShippingRatesRequest_Pickup) UnmarshalJSON(b []byte) error
type ShippingRatesResponse ¶
type ShippingRatesResponse struct {
ShippingRates *[]ShippingRate `json:"shipping_rates,omitempty"`
}
ShippingRatesResponse The response returned for shipping rates for one or more carriers.
type StatusField ¶
type StatusField string
StatusField defines model for status-field.
const ( ACTIVE StatusField = "ACTIVE" DELETED StatusField = "DELETED" INACTIVE StatusField = "INACTIVE" )
Defines values for StatusField.
type StringConditionField ¶
type StringConditionField struct {
Operator *StringConditionFieldOperator `json:"operator,omitempty"`
Value *[]string `json:"value,omitempty"`
}
StringConditionField defines model for string-condition-field.
type StringConditionFieldOperator ¶
type StringConditionFieldOperator string
StringConditionFieldOperator defines model for StringConditionField.Operator.
const ( EXCLUSION StringConditionFieldOperator = "EXCLUSION" INCLUSION StringConditionFieldOperator = "INCLUSION" )
Defines values for StringConditionFieldOperator.
type UpdateAttributeJSONRequestBody ¶
type UpdateAttributeJSONRequestBody = AttributeRequest
UpdateAttributeJSONRequestBody defines body for UpdateAttribute for application/json ContentType.
type UpdateAttributeParams ¶
type UpdateAttributeParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateAttributeParams defines parameters for UpdateAttribute.
type UpdateAttributeResponse ¶
type UpdateAttributeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AttributeResponse
}
func ParseUpdateAttributeResponse ¶
func ParseUpdateAttributeResponse(rsp *http.Response) (*UpdateAttributeResponse, error)
ParseUpdateAttributeResponse parses an HTTP response from a UpdateAttributeWithResponse call
func (UpdateAttributeResponse) Status ¶
func (r UpdateAttributeResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateAttributeResponse) StatusCode ¶
func (r UpdateAttributeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateAutomationRuleJSONRequestBody ¶
type UpdateAutomationRuleJSONRequestBody = AutomationRuleRequest
UpdateAutomationRuleJSONRequestBody defines body for UpdateAutomationRule for application/json ContentType.
type UpdateAutomationRuleParams ¶
type UpdateAutomationRuleParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateAutomationRuleParams defines parameters for UpdateAutomationRule.
type UpdateAutomationRuleResponse ¶
type UpdateAutomationRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AutomationRuleResponse
}
func ParseUpdateAutomationRuleResponse ¶
func ParseUpdateAutomationRuleResponse(rsp *http.Response) (*UpdateAutomationRuleResponse, error)
ParseUpdateAutomationRuleResponse parses an HTTP response from a UpdateAutomationRuleWithResponse call
func (UpdateAutomationRuleResponse) Status ¶
func (r UpdateAutomationRuleResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateAutomationRuleResponse) StatusCode ¶
func (r UpdateAutomationRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateAutomationRulesSequenceJSONRequestBody ¶
type UpdateAutomationRulesSequenceJSONRequestBody = SequencesRequest
UpdateAutomationRulesSequenceJSONRequestBody defines body for UpdateAutomationRulesSequence for application/json ContentType.
type UpdateAutomationRulesSequenceParams ¶
type UpdateAutomationRulesSequenceParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateAutomationRulesSequenceParams defines parameters for UpdateAutomationRulesSequence.
type UpdateAutomationRulesSequenceResponse ¶
type UpdateAutomationRulesSequenceResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SequencesRequest
}
func ParseUpdateAutomationRulesSequenceResponse ¶
func ParseUpdateAutomationRulesSequenceResponse(rsp *http.Response) (*UpdateAutomationRulesSequenceResponse, error)
ParseUpdateAutomationRulesSequenceResponse parses an HTTP response from a UpdateAutomationRulesSequenceWithResponse call
func (UpdateAutomationRulesSequenceResponse) Status ¶
func (r UpdateAutomationRulesSequenceResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateAutomationRulesSequenceResponse) StatusCode ¶
func (r UpdateAutomationRulesSequenceResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateAutomationRulesetAndRulesJSONRequestBody ¶
type UpdateAutomationRulesetAndRulesJSONRequestBody = AutomationRulesetWithRulesRequest
UpdateAutomationRulesetAndRulesJSONRequestBody defines body for UpdateAutomationRulesetAndRules for application/json ContentType.
type UpdateAutomationRulesetAndRulesParams ¶
type UpdateAutomationRulesetAndRulesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateAutomationRulesetAndRulesParams defines parameters for UpdateAutomationRulesetAndRules.
type UpdateAutomationRulesetAndRulesResponse ¶
type UpdateAutomationRulesetAndRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AutomationRulesetWithRulesResponse
}
func ParseUpdateAutomationRulesetAndRulesResponse ¶
func ParseUpdateAutomationRulesetAndRulesResponse(rsp *http.Response) (*UpdateAutomationRulesetAndRulesResponse, error)
ParseUpdateAutomationRulesetAndRulesResponse parses an HTTP response from a UpdateAutomationRulesetAndRulesWithResponse call
func (UpdateAutomationRulesetAndRulesResponse) Status ¶
func (r UpdateAutomationRulesetAndRulesResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateAutomationRulesetAndRulesResponse) StatusCode ¶
func (r UpdateAutomationRulesetAndRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateCarrierAccountJSONRequestBody ¶
type UpdateCarrierAccountJSONRequestBody = CarrierAccountEndpointRequest
UpdateCarrierAccountJSONRequestBody defines body for UpdateCarrierAccount for application/json ContentType.
type UpdateCarrierAccountParams ¶
type UpdateCarrierAccountParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateCarrierAccountParams defines parameters for UpdateCarrierAccount.
type UpdateCarrierAccountResponse ¶
type UpdateCarrierAccountResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CarrierAccountEndpointObject
}
func ParseUpdateCarrierAccountResponse ¶
func ParseUpdateCarrierAccountResponse(rsp *http.Response) (*UpdateCarrierAccountResponse, error)
ParseUpdateCarrierAccountResponse parses an HTTP response from a UpdateCarrierAccountWithResponse call
func (UpdateCarrierAccountResponse) Status ¶
func (r UpdateCarrierAccountResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateCarrierAccountResponse) StatusCode ¶
func (r UpdateCarrierAccountResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateCollectionScheduleJSONRequestBody ¶
type UpdateCollectionScheduleJSONRequestBody = CollectionRequest
UpdateCollectionScheduleJSONRequestBody defines body for UpdateCollectionSchedule for application/json ContentType.
type UpdateCollectionScheduleParams ¶
type UpdateCollectionScheduleParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
UpdateCollectionScheduleParams defines parameters for UpdateCollectionSchedule.
type UpdateCollectionScheduleResponse ¶
type UpdateCollectionScheduleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
}
func ParseUpdateCollectionScheduleResponse ¶
func ParseUpdateCollectionScheduleResponse(rsp *http.Response) (*UpdateCollectionScheduleResponse, error)
ParseUpdateCollectionScheduleResponse parses an HTTP response from a UpdateCollectionScheduleWithResponse call
func (UpdateCollectionScheduleResponse) Status ¶
func (r UpdateCollectionScheduleResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateCollectionScheduleResponse) StatusCode ¶
func (r UpdateCollectionScheduleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateDeliveryPromiseJSONRequestBody ¶
type UpdateDeliveryPromiseJSONRequestBody = PromisedDeliveryDateRequest
UpdateDeliveryPromiseJSONRequestBody defines body for UpdateDeliveryPromise for application/json ContentType.
type UpdateDeliveryPromiseParams ¶
type UpdateDeliveryPromiseParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
UpdateDeliveryPromiseParams defines parameters for UpdateDeliveryPromise.
type UpdateDeliveryPromiseResponse ¶
type UpdateDeliveryPromiseResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
}
func ParseUpdateDeliveryPromiseResponse ¶
func ParseUpdateDeliveryPromiseResponse(rsp *http.Response) (*UpdateDeliveryPromiseResponse, error)
ParseUpdateDeliveryPromiseResponse parses an HTTP response from a UpdateDeliveryPromiseWithResponse call
func (UpdateDeliveryPromiseResponse) Status ¶
func (r UpdateDeliveryPromiseResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateDeliveryPromiseResponse) StatusCode ¶
func (r UpdateDeliveryPromiseResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateDeliveryScheduleJSONRequestBody ¶
type UpdateDeliveryScheduleJSONRequestBody = CollectionRequest
UpdateDeliveryScheduleJSONRequestBody defines body for UpdateDeliverySchedule for application/json ContentType.
type UpdateDeliveryScheduleParams ¶
type UpdateDeliveryScheduleParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
UpdateDeliveryScheduleParams defines parameters for UpdateDeliverySchedule.
type UpdateDeliveryScheduleResponse ¶
type UpdateDeliveryScheduleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
}
func ParseUpdateDeliveryScheduleResponse ¶
func ParseUpdateDeliveryScheduleResponse(rsp *http.Response) (*UpdateDeliveryScheduleResponse, error)
ParseUpdateDeliveryScheduleResponse parses an HTTP response from a UpdateDeliveryScheduleWithResponse call
func (UpdateDeliveryScheduleResponse) Status ¶
func (r UpdateDeliveryScheduleResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateDeliveryScheduleResponse) StatusCode ¶
func (r UpdateDeliveryScheduleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateParcelsJSONRequestBody ¶
type UpdateParcelsJSONRequestBody = UpdateParcelsRequest
UpdateParcelsJSONRequestBody defines body for UpdateParcels for application/json ContentType.
type UpdateParcelsParams ¶
type UpdateParcelsParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
UpdateParcelsParams defines parameters for UpdateParcels.
type UpdateParcelsRequest ¶
type UpdateParcelsRequest struct {
Parcels *[]ParcelRequest `json:"parcels,omitempty"`
}
UpdateParcelsRequest defines model for update-parcels-request.
type UpdateParcelsResponse ¶
type UpdateParcelsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
}
func ParseUpdateParcelsResponse ¶
func ParseUpdateParcelsResponse(rsp *http.Response) (*UpdateParcelsResponse, error)
ParseUpdateParcelsResponse parses an HTTP response from a UpdateParcelsWithResponse call
func (UpdateParcelsResponse) Status ¶
func (r UpdateParcelsResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateParcelsResponse) StatusCode ¶
func (r UpdateParcelsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateServiceLevelRuleJSONRequestBody ¶
type UpdateServiceLevelRuleJSONRequestBody = ServiceLevelRuleRequest
UpdateServiceLevelRuleJSONRequestBody defines body for UpdateServiceLevelRule for application/json ContentType.
type UpdateServiceLevelRuleParams ¶
type UpdateServiceLevelRuleParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateServiceLevelRuleParams defines parameters for UpdateServiceLevelRule.
type UpdateServiceLevelRuleResponse ¶
type UpdateServiceLevelRuleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ServiceLevelRuleResponse
}
func ParseUpdateServiceLevelRuleResponse ¶
func ParseUpdateServiceLevelRuleResponse(rsp *http.Response) (*UpdateServiceLevelRuleResponse, error)
ParseUpdateServiceLevelRuleResponse parses an HTTP response from a UpdateServiceLevelRuleWithResponse call
func (UpdateServiceLevelRuleResponse) Status ¶
func (r UpdateServiceLevelRuleResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateServiceLevelRuleResponse) StatusCode ¶
func (r UpdateServiceLevelRuleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateServiceLevelRulesSequenceJSONRequestBody ¶
type UpdateServiceLevelRulesSequenceJSONRequestBody = SequencesRequest
UpdateServiceLevelRulesSequenceJSONRequestBody defines body for UpdateServiceLevelRulesSequence for application/json ContentType.
type UpdateServiceLevelRulesSequenceParams ¶
type UpdateServiceLevelRulesSequenceParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateServiceLevelRulesSequenceParams defines parameters for UpdateServiceLevelRulesSequence.
type UpdateServiceLevelRulesSequenceResponse ¶
type UpdateServiceLevelRulesSequenceResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SequencesRequest
}
func ParseUpdateServiceLevelRulesSequenceResponse ¶
func ParseUpdateServiceLevelRulesSequenceResponse(rsp *http.Response) (*UpdateServiceLevelRulesSequenceResponse, error)
ParseUpdateServiceLevelRulesSequenceResponse parses an HTTP response from a UpdateServiceLevelRulesSequenceWithResponse call
func (UpdateServiceLevelRulesSequenceResponse) Status ¶
func (r UpdateServiceLevelRulesSequenceResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateServiceLevelRulesSequenceResponse) StatusCode ¶
func (r UpdateServiceLevelRulesSequenceResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateServiceLevelRulesetAndRulesJSONRequestBody ¶
type UpdateServiceLevelRulesetAndRulesJSONRequestBody = ServiceLevelRulesetWithRulesRequest
UpdateServiceLevelRulesetAndRulesJSONRequestBody defines body for UpdateServiceLevelRulesetAndRules for application/json ContentType.
type UpdateServiceLevelRulesetAndRulesParams ¶
type UpdateServiceLevelRulesetAndRulesParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateServiceLevelRulesetAndRulesParams defines parameters for UpdateServiceLevelRulesetAndRules.
type UpdateServiceLevelRulesetAndRulesResponse ¶
type UpdateServiceLevelRulesetAndRulesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ServiceLevelRulesetWithRulesResponse
}
func ParseUpdateServiceLevelRulesetAndRulesResponse ¶
func ParseUpdateServiceLevelRulesetAndRulesResponse(rsp *http.Response) (*UpdateServiceLevelRulesetAndRulesResponse, error)
ParseUpdateServiceLevelRulesetAndRulesResponse parses an HTTP response from a UpdateServiceLevelRulesetAndRulesWithResponse call
func (UpdateServiceLevelRulesetAndRulesResponse) Status ¶
func (r UpdateServiceLevelRulesetAndRulesResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateServiceLevelRulesetAndRulesResponse) StatusCode ¶
func (r UpdateServiceLevelRulesetAndRulesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateShipmentJSONRequestBody ¶
type UpdateShipmentJSONRequestBody = ShipmentDraftRequest
UpdateShipmentJSONRequestBody defines body for UpdateShipment for application/json ContentType.
type UpdateShipmentParams ¶
type UpdateShipmentParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
UpdateShipmentParams defines parameters for UpdateShipment.
type UpdateShipmentPatchJSONRequestBody ¶
type UpdateShipmentPatchJSONRequestBody = ShipmentDraftRequest
UpdateShipmentPatchJSONRequestBody defines body for UpdateShipmentPatch for application/json ContentType.
type UpdateShipmentPatchParams ¶
type UpdateShipmentPatchParams struct {
XApiKey string `json:"x-api-key"`
TenantId string `json:"tenant-id"`
ContentType string `json:"Content-Type"`
}
UpdateShipmentPatchParams defines parameters for UpdateShipmentPatch.
type UpdateShipmentPatchResponse ¶
type UpdateShipmentPatchResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
JSON400 *struct {
Errors []string `json:"errors"`
Status string `json:"status"`
Timestamp string `json:"timestamp"`
}
}
func ParseUpdateShipmentPatchResponse ¶
func ParseUpdateShipmentPatchResponse(rsp *http.Response) (*UpdateShipmentPatchResponse, error)
ParseUpdateShipmentPatchResponse parses an HTTP response from a UpdateShipmentPatchWithResponse call
func (UpdateShipmentPatchResponse) Status ¶
func (r UpdateShipmentPatchResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateShipmentPatchResponse) StatusCode ¶
func (r UpdateShipmentPatchResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateShipmentResponse ¶
type UpdateShipmentResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
JSON400 *struct {
Errors []string `json:"errors"`
Status string `json:"status"`
Timestamp string `json:"timestamp"`
}
}
func ParseUpdateShipmentResponse ¶
func ParseUpdateShipmentResponse(rsp *http.Response) (*UpdateShipmentResponse, error)
ParseUpdateShipmentResponse parses an HTTP response from a UpdateShipmentWithResponse call
func (UpdateShipmentResponse) Status ¶
func (r UpdateShipmentResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateShipmentResponse) StatusCode ¶
func (r UpdateShipmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateStatusJSONBody ¶
type UpdateStatusJSONBody struct {
NewStatus *string `json:"new_status,omitempty"`
UpdateDate *string `json:"update_date,omitempty"`
}
UpdateStatusJSONBody defines parameters for UpdateStatus.
type UpdateStatusJSONRequestBody ¶
type UpdateStatusJSONRequestBody UpdateStatusJSONBody
UpdateStatusJSONRequestBody defines body for UpdateStatus for application/json ContentType.
type UpdateStatusParams ¶
type UpdateStatusParams struct {
XApiKey *string `json:"x-api-key,omitempty"`
TenantId *string `json:"tenant-id,omitempty"`
ContentType *string `json:"Content-Type,omitempty"`
}
UpdateStatusParams defines parameters for UpdateStatus.
type UpdateStatusResponse ¶
type UpdateStatusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShipmentObject
JSON400 *struct {
Errors *[]string `json:"errors,omitempty"`
Status *string `json:"status,omitempty"`
Timestamp *string `json:"timestamp,omitempty"`
}
}
func ParseUpdateStatusResponse ¶
func ParseUpdateStatusResponse(rsp *http.Response) (*UpdateStatusResponse, error)
ParseUpdateStatusResponse parses an HTTP response from a UpdateStatusWithResponse call
func (UpdateStatusResponse) Status ¶
func (r UpdateStatusResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateStatusResponse) StatusCode ¶
func (r UpdateStatusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Weight ¶
type Weight struct {
// Unit Default weight unit is `kg` if not provided.
Unit *WeightUnit `json:"unit,omitempty"`
Value *float32 `json:"value,omitempty"`
}
Weight defines model for weight.
type WeightUnit ¶
type WeightUnit string
WeightUnit Default weight unit is `kg` if not provided.
const (
WeightUnitKg WeightUnit = "kg"
)
Defines values for WeightUnit.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.