package
0.0.0-20240405104727-3fc460ca096e
Repository: https://github.com/brandedtech/sp-api-sdk.git
Documentation: pkg.go.dev

# Functions

NewCancelShipmentRequest generates requests for CancelShipment.
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCreateShipmentRequest calls the generic CreateShipment builder with application/json body.
NewCreateShipmentRequestWithBody generates requests for CreateShipment with any type of body.
NewGetAccountRequest generates requests for GetAccount.
NewGetRatesRequest calls the generic GetRates builder with application/json body.
NewGetRatesRequestWithBody generates requests for GetRates with any type of body.
NewGetShipmentRequest generates requests for GetShipment.
NewGetTrackingInformationRequest generates requests for GetTrackingInformation.
NewPurchaseLabelsRequest calls the generic PurchaseLabels builder with application/json body.
NewPurchaseLabelsRequestWithBody generates requests for PurchaseLabels with any type of body.
NewPurchaseShipmentRequest calls the generic PurchaseShipment builder with application/json body.
NewPurchaseShipmentRequestWithBody generates requests for PurchaseShipment with any type of body.
NewRetrieveShippingLabelRequest calls the generic RetrieveShippingLabel builder with application/json body.
NewRetrieveShippingLabelRequestWithBody generates requests for RetrieveShippingLabel with any type of body.
ParseCancelShipmentResp parses an HTTP response from a CancelShipmentWithResponse call.
ParseCreateShipmentResp parses an HTTP response from a CreateShipmentWithResponse call.
ParseGetAccountResp parses an HTTP response from a GetAccountWithResponse call.
ParseGetRatesResp parses an HTTP response from a GetRatesWithResponse call.
ParseGetShipmentResp parses an HTTP response from a GetShipmentWithResponse call.
ParseGetTrackingInformationResp parses an HTTP response from a GetTrackingInformationWithResponse call.
ParsePurchaseLabelsResp parses an HTTP response from a PurchaseLabelsWithResponse call.
ParsePurchaseShipmentResp parses an HTTP response from a PurchaseShipmentWithResponse call.
ParseRetrieveShippingLabelResp parses an HTTP response from a RetrieveShippingLabelWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestBefore allows setting up a callback function, which will be called right before sending the request.
WithResponseAfter allows setting up a callback function, which will be called right after get response the request.
WithUserAgent set up useragent add user agent to every request automatically.

# Constants

# Structs

AcceptedRate defines model for AcceptedRate.
Account defines model for Account.
Address defines model for Address.
No description provided by the author
CancelShipmentResponse defines model for CancelShipmentResponse.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
Container defines model for Container.
ContainerItem defines model for ContainerItem.
ContainerSpecification defines model for ContainerSpecification.
CreateShipmentRequest defines model for CreateShipmentRequest.
No description provided by the author
CreateShipmentResponse defines model for CreateShipmentResponse.
CreateShipmentResult defines model for CreateShipmentResult.
Currency defines model for Currency.
Dimensions defines model for Dimensions.
Error defines model for Error.
Event defines model for Event.
No description provided by the author
GetAccountResponse defines model for GetAccountResponse.
GetRatesRequest defines model for GetRatesRequest.
No description provided by the author
GetRatesResponse defines model for GetRatesResponse.
GetRatesResult defines model for GetRatesResult.
No description provided by the author
GetShipmentResponse defines model for GetShipmentResponse.
No description provided by the author
GetTrackingInformationResponse defines model for GetTrackingInformationResponse.
Label defines model for Label.
LabelResult defines model for LabelResult.
LabelSpecification defines model for LabelSpecification.
Location defines model for Location.
Party defines model for Party.
PurchaseLabelsRequest defines model for PurchaseLabelsRequest.
No description provided by the author
PurchaseLabelsResponse defines model for PurchaseLabelsResponse.
PurchaseLabelsResult defines model for PurchaseLabelsResult.
PurchaseShipmentRequest defines model for PurchaseShipmentRequest.
No description provided by the author
PurchaseShipmentResponse defines model for PurchaseShipmentResponse.
PurchaseShipmentResult defines model for PurchaseShipmentResult.
Rate defines model for Rate.
RetrieveShippingLabelRequest defines model for RetrieveShippingLabelRequest.
No description provided by the author
RetrieveShippingLabelResponse defines model for RetrieveShippingLabelResponse.
RetrieveShippingLabelResult defines model for RetrieveShippingLabelResult.
ServiceRate defines model for ServiceRate.
Shipment defines model for Shipment.
ShippingPromiseSet defines model for ShippingPromiseSet.
TimeRange defines model for TimeRange.
TrackingInformation defines model for TrackingInformation.
TrackingSummary defines model for TrackingSummary.
Weight defines model for Weight.

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.

# Type aliases

AccountId defines model for AccountId.
City defines model for City.
ClientOption allows setting custom parameters during construction.
ClientReferenceId defines model for ClientReferenceId.
ContainerList defines model for ContainerList.
ContainerReferenceId defines model for ContainerReferenceId.
ContainerSpecificationList defines model for ContainerSpecificationList.
CountryCode defines model for CountryCode.
CreateShipmentJSONBody defines parameters for CreateShipment.
CreateShipmentRequestBody defines body for CreateShipment for application/json ContentType.
ErrorList defines model for ErrorList.
EventCode defines model for EventCode.
EventList defines model for EventList.
GetRatesJSONBody defines parameters for GetRates.
GetRatesRequestBody defines body for GetRates for application/json ContentType.
LabelResultList defines model for LabelResultList.
LabelStream defines model for LabelStream.
PostalCode defines model for PostalCode.
PromisedDeliveryDate defines model for PromisedDeliveryDate.
PurchaseLabelsJSONBody defines parameters for PurchaseLabels.
PurchaseLabelsRequestBody defines body for PurchaseLabels for application/json ContentType.
PurchaseShipmentJSONBody defines parameters for PurchaseShipment.
PurchaseShipmentRequestBody defines body for PurchaseShipment for application/json ContentType.
RateId defines model for RateId.
RateList defines model for RateList.
RequestBeforeFn is the function signature for the RequestBefore callback function.
ResponseAfterFn is the function signature for the ResponseAfter callback function.
RetrieveShippingLabelJSONBody defines parameters for RetrieveShippingLabel.
RetrieveShippingLabelRequestBody defines body for RetrieveShippingLabel for application/json ContentType.
ServiceRateList defines model for ServiceRateList.
ServiceType defines model for ServiceType.
ServiceTypeList defines model for ServiceTypeList.
ShipmentId defines model for ShipmentId.
StateOrRegion defines model for StateOrRegion.
TrackingId defines model for TrackingId.