Skip to content

Latest commit

 

History

History
154 lines (100 loc) · 6.33 KB

ReturnsAPI.md

File metadata and controls

154 lines (100 loc) · 6.33 KB

\ReturnsAPI

All URIs are relative to http://example.com/rest/default

Method HTTP request Description
GetV1Returns Get /V1/returns returns
PostV1Returns Post /V1/returns returns

GetV1Returns

RmaDataRmaSearchResultInterface GetV1Returns(ctx).SearchCriteriaFilterGroups0Filters0Field(searchCriteriaFilterGroups0Filters0Field).SearchCriteriaFilterGroups0Filters0Value(searchCriteriaFilterGroups0Filters0Value).SearchCriteriaFilterGroups0Filters0ConditionType(searchCriteriaFilterGroups0Filters0ConditionType).SearchCriteriaSortOrders0Field(searchCriteriaSortOrders0Field).SearchCriteriaSortOrders0Direction(searchCriteriaSortOrders0Direction).SearchCriteriaPageSize(searchCriteriaPageSize).SearchCriteriaCurrentPage(searchCriteriaCurrentPage).Execute()

returns

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/Hevelop/go-client-magento"
)

func main() {
	searchCriteriaFilterGroups0Filters0Field := "searchCriteriaFilterGroups0Filters0Field_example" // string | Field (optional)
	searchCriteriaFilterGroups0Filters0Value := "searchCriteriaFilterGroups0Filters0Value_example" // string | Value (optional)
	searchCriteriaFilterGroups0Filters0ConditionType := "searchCriteriaFilterGroups0Filters0ConditionType_example" // string | Condition type (optional)
	searchCriteriaSortOrders0Field := "searchCriteriaSortOrders0Field_example" // string | Sorting field. (optional)
	searchCriteriaSortOrders0Direction := "searchCriteriaSortOrders0Direction_example" // string | Sorting direction. (optional)
	searchCriteriaPageSize := int32(56) // int32 | Page size. (optional)
	searchCriteriaCurrentPage := int32(56) // int32 | Current page. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ReturnsAPI.GetV1Returns(context.Background()).SearchCriteriaFilterGroups0Filters0Field(searchCriteriaFilterGroups0Filters0Field).SearchCriteriaFilterGroups0Filters0Value(searchCriteriaFilterGroups0Filters0Value).SearchCriteriaFilterGroups0Filters0ConditionType(searchCriteriaFilterGroups0Filters0ConditionType).SearchCriteriaSortOrders0Field(searchCriteriaSortOrders0Field).SearchCriteriaSortOrders0Direction(searchCriteriaSortOrders0Direction).SearchCriteriaPageSize(searchCriteriaPageSize).SearchCriteriaCurrentPage(searchCriteriaCurrentPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReturnsAPI.GetV1Returns``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetV1Returns`: RmaDataRmaSearchResultInterface
	fmt.Fprintf(os.Stdout, "Response from `ReturnsAPI.GetV1Returns`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetV1ReturnsRequest struct via the builder pattern

Name Type Description Notes
searchCriteriaFilterGroups0Filters0Field string Field
searchCriteriaFilterGroups0Filters0Value string Value
searchCriteriaFilterGroups0Filters0ConditionType string Condition type
searchCriteriaSortOrders0Field string Sorting field.
searchCriteriaSortOrders0Direction string Sorting direction.
searchCriteriaPageSize int32 Page size.
searchCriteriaCurrentPage int32 Current page.

Return type

RmaDataRmaSearchResultInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostV1Returns

RmaDataRmaInterface PostV1Returns(ctx).PostV1ReturnsRequest(postV1ReturnsRequest).Execute()

returns

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/Hevelop/go-client-magento"
)

func main() {
	postV1ReturnsRequest := *openapiclient.NewPostV1ReturnsRequest(*openapiclient.NewRmaDataRmaInterface("IncrementId_example", int32(123), int32(123), "OrderIncrementId_example", int32(123), int32(123), "DateRequested_example", "CustomerCustomEmail_example", []openapiclient.RmaDataItemInterface{*openapiclient.NewRmaDataItemInterface(int32(123), int32(123), int32(123), int32(123), int32(123), int32(123), int32(123), "Reason_example", "Condition_example", "Resolution_example", "Status_example")}, "Status_example", []openapiclient.RmaDataCommentInterface{*openapiclient.NewRmaDataCommentInterface("Comment_example", int32(123), "CreatedAt_example", int32(123), false, false, "Status_example", false)}, []openapiclient.RmaDataTrackInterface{*openapiclient.NewRmaDataTrackInterface(int32(123), int32(123), "TrackNumber_example", "CarrierTitle_example", "CarrierCode_example")})) // PostV1ReturnsRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ReturnsAPI.PostV1Returns(context.Background()).PostV1ReturnsRequest(postV1ReturnsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReturnsAPI.PostV1Returns``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostV1Returns`: RmaDataRmaInterface
	fmt.Fprintf(os.Stdout, "Response from `ReturnsAPI.PostV1Returns`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostV1ReturnsRequest struct via the builder pattern

Name Type Description Notes
postV1ReturnsRequest PostV1ReturnsRequest

Return type

RmaDataRmaInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]