Log ind

nShift Help Center

Pull API

Avatar
Malene Tidemann
Opdateret

Afdelinger i denne artikel:

 

Offentlig API-autentificering

Returns offentlige API bruger Basic Authentication. Alle metoder, der er en del af API'en, bruger de samme oplysninger til autentificering, brugernavn og adgangskode for din organisation (billede, der viser brugsscenarie fra Postman nedenfor).

 

returns-authentication.png

 

Endpoints

Hent liste over returneringsordrer

URL: GET /return-orders

Endpoint returnerer en liste over returneringsordrer baseret på de forespørgselsstrengparametre, der sendes i metoden.


Parametre:

Parameter Type Påkrævet
updatedAfter DateTime (ISO-format) Nej
updatedBefore DateTime (ISO-format) Nej
createdAfter DateTime (ISO-format) Nej
createdBefore DateTime (ISO-format) Nej

 

Eksempel på kald:

GET https://staging.returnado.com/public-api/v3/return-orders?updatedAfter=2022-12-20T01:30:00.
000-05:00&updatedBefore=2022-12-31T01:30:00.000-05:00&createdAfter=2022-12-20T01:30:00.000-05:0
0&createdBefore=2022-12-31T01:30:00.000-05:00


Henter alle returneringsordrer opdateret efter 2022/12/20 og før 2022/12/31 og oprettet efter 2020/12/20 og før 2022/12/31.

 

Svar

ResponseWrapper:

Felt Type Beskrivelse
records ReturnOrder[] Poster fundet ved søgning
totalRecords integer Antal fundne poster

 

{
  "records": [
    {
      "returnOrderId": 56373,
      "returnOrderExtId": "{}",
      "orderId": "249-307",
      "createdAt": "2022-12-20T18:02:31Z",
      "updatedAt": "2022-12-20T18:02:32Z",
      "marketCode": "27001",
      "customerId": "john_doe@nshift.com",
      "status": "pre_approval",
      "currency": "GBP",
      "netOriginalTotal": 1198.8,
      "taxOriginalTotal": 0,
      "grossOriginalTotal": 1198.8,
      "netRefundItemsTotal": 999,
      "taxRefundItemsTotal": 0,
      "grossRefundItemsTotal": 999,
      "netShippingFeeRefund": 0,
      "taxShippingFeeRefund": 0,
      "grossShippingFeeRefund": 0,
      "netFeesTotal": 0,
      "taxFeesTotal": 0,
      "grossFeesTotal": 0,
      "netRefundTotal": 999,
      "taxRefundTotal": 0,
      "grossRefundTotal": 999,
      "items": [
        {
          "returnOrderId": 56373,
          "returnOrderExtId": "{}",
          "returnOrderItemId": 120808,
          "originalOrderItemId": "1",
          "productId": "iris",
          "productVariantId": "iris",
          "originalNetAmount": 999,
          "originalTaxAmount": 0,
          "originalGrossAmount": 999,
          "reportedCondition": "tags_are_intact",
          "reclamationReason": "style_doesnt_suit",
          "nextAction": "restock",
          "status": "pending",
          "refundQuantity": 1,
          "netRefundAmount": 999,
          "taxRefundAmount": 0,
          "grossRefundAmount": 999
        }
      ]
    }
  ],
  "totalRecords": 1
}

 

 

Hent returneringsordrepost efter Id

URL: GET /return-orders/{returnOrderId}

Endpoint returnerer returneringsordren identificeret ved det id, der bruges i URL-stien.

 

Parametre:

Parameter Type Påkrævet
returnOrderId integer ja

 

Eksempel på kald:

GET https://staging.returnado.com/public-api/v3/return-orders/56373

Henter returneringsordren, der identificeres ved id'et 56373.

 

Svar:

ReturnOrder

{
  "returnOrderId": 56373,
  "returnOrderExtId": "{}",
  "orderId": "249-307",
  "createdAt": "2022-12-20T18:02:31Z",
  "updatedAt": "2022-12-20T18:02:32Z",
  "marketCode": "27001",
  "customerId": "john_doe@nshift.com",
  "status": "pre_approval",
  "currency": "GBP",
  "netOriginalTotal": 1198.8,
  "taxOriginalTotal": 0,
  "grossOriginalTotal": 1198.8,
  "netRefundItemsTotal": 999,
  "taxRefundItemsTotal": 0,
  "grossRefundItemsTotal": 999,
  "netShippingFeeRefund": 0,
  "taxShippingFeeRefund": 0,
  "grossShippingFeeRefund": 0,
  "netFeesTotal": 0,
  "taxFeesTotal": 0,
  "grossFeesTotal": 0,
  "netRefundTotal": 999,
  "taxRefundTotal": 0,
  "grossRefundTotal": 999,
  "items": [
    {
      "returnOrderId": 56373,
      "returnOrderExtId": "{}",
      "returnOrderItemId": 120808,
      "originalOrderItemId": "1",
      "productId": "iris",
      "productVariantId": "iris",
      "originalNetAmount": 999,
      "originalTaxAmount": 0,
      "originalGrossAmount": 999,
      "reportedCondition": "tags_are_intact",
      "reclamationReason": "style_doesnt_suit",
      "nextAction": "restock",
      "status": "pending",
      "refundQuantity": 1,
      "netRefundAmount": 999,
      "taxRefundAmount": 0,
      "grossRefundAmount": 999
    }
  ]
}

 

 

Hent oversigt over returneringer

URL: GET /returns-summary

Endpoint returnerer oversigten over returneringsordrer for den kunde, der anmoder om dem. 

Baseret på filtrene kan endpointet bruges til kun at filtrere returneringsordrer for et specifikt marked (for eksempel kun Sverige, hvis returneringsordrer er registreret for både UK og Sverige).

periodStart og periodEnd anvendes på datoen, hvor return_order sidst blev opdateret.


Denne endpoint inkluderer også paginering. Paginering starter med side 0.


Parametre:

Parameter Type Påkrævet
periodStart DateTime (ISO-format) ja
periodEnd DateTime (ISO-format) nej
marketCode integer nej
pageSize integer nej
pageNumber integer nej

 

Eksempel på kald:

GET https://staging.returnado.com/public-api/v3/returns-summary?periodStart=2022-12-10T01:30:00
.000-05:00&periodEnd=2022-12-31T01:30:00.000-05:00&marketCode=27001&pageSize=5&pageNumber=1

 

Henter ordrer, der tilhører det identificerede marked, opdateret inden for den nævnte periode. På grund af paginering springer den de første 5 ordrer over (ordnet efter return_order_item_id)

 

Svar:

Returnerer PaginatedResponse<ReturnSummary>

Felt Type Påkrævet
records ReturnSummary[] Returneringsoversigter returneret ved søgning
totalRecords integer Antal fundne poster
pagination.totalPages integer Antal sider dækket af resultater i den aktuelle pagineringskonfiguration
pagination.currentPage integer Side, som de aktuelt hentede data tilhører
pagination.currentPageSize integer Antal returneringsordreoversigter pr. side, som API'en aktuelt henter

 

{
  "records": [
    {
      "marketCode": "27001",
      "marketName": "Arena-1",
      "customerId": "john_doe_1@gmail.com",
      "orderId": "968-309",
      "returnOrderId": 56367,
      "returnOrderItemId": 120801,
      "productId": "hermes",
      "productVariantId": "hermes",
      "sku": "hermes",
      "productName": "hermes",
      "currencyCode": "GBP",
      "returnedQuantity": 1,
      "returnReasonCode": "style_doesnt_suit",
      "itemConditionCode": "accessory_missing",
      "nextActionCode": "restock",
      "originalValueGross": 579,
      "returnValueGross": 579,
      "reconversionValueGross": 0,
      "refundValueGross": 579,
      "orderCreatedAt": "2022-12-19T10:19:36Z",
      "createdAt": "2022-12-19T10:22:10Z",
      "currentState": "awaiting_approval",
      "stateUpdatedAt": "2022-12-19T10:22:10Z",
      "claim": false,
      "refundApproved": false
    },
    {
      "marketCode": "27001",
      "marketName": "Arena-1",
      "customerId": "john_doe_2@nshift.com",
      "orderId": "819-761",
      "returnOrderId": 56368,
      "returnOrderItemId": 120802,
      "productId": "hera",
      "productVariantId": "hera",
      "sku": "hera",
      "productName": "hera",
      "currencyCode": "GBP",
      "returnedQuantity": 1,
      "returnReasonCode": "colour_not_as_expected",
      "itemConditionCode": "accessory_missing",
      "nextActionCode": "restock",
      "originalValueGross": 39,
      "returnValueGross": 39,
      "reconversionValueGross": 0,
      "refundValueGross": 39,
      "orderCreatedAt": "2022-12-19T14:57:25Z",
      "createdAt": "2022-12-19T14:58:37Z",
      "currentState": "awaiting_approval",
      "stateUpdatedAt": "2022-12-19T14:58:37Z",
      "claim": false,
      "refundApproved": false
    },
    {
      "marketCode": "27001",
      "marketName": "Arena-1",
      "customerId": "john_doe@nshift.com",
      "orderId": "249-307",
      "returnOrderId": 56373,
      "returnOrderItemId": 120808,
      "productId": "iris",
      "productVariantId": "iris",
      "sku": "iris",
      "productName": "iris",
      "currencyCode": "GBP",
      "returnedQuantity": 1,
      "returnReasonCode": "style_doesnt_suit",
      "itemConditionCode": "tags_are_intact",
      "nextActionCode": "restock",
      "originalValueGross": 999,
      "returnValueGross": 999,
      "reconversionValueGross": 0,
      "refundValueGross": 999,
      "orderCreatedAt": "2022-12-20T17:59:56Z",
      "createdAt": "2022-12-20T18:02:31Z",
      "currentState": "awaiting_approval",
      "stateUpdatedAt": "2022-12-20T18:02:32Z",
      "claim": false,
      "refundApproved": false
    }
  ],
  "totalRecords": 8,
  "pagination": {
    "totalPages": 2,
    "currentPage": 1,
    "currentPageSize": 3
  }
}

Endpointet for ReturnOrderSummary bringer også information om ordrestatus samt refusionsstatus.

 

 

Opdater returneringsordre refusionsstatus

URL: PUT /update-return-status/{returnOrderId}

Denne endpoint bruges til at opdatere status for returneringsordren.

 

Parametre:

Felt Type Påkrævet
returnOrderId bool sand

 

Request Body:

{
  "refundSucceeded": true,
  "orderId": null,
  "errorCode": "e404",
  "errorDescription": "insufficient funds"
}

 

Parameter Type Påkrævet
refundSucceeded boolean ja
orderId string nej
errorCode string nej
errorDescription string nej

 

Eksempel på kald:

PUT https://staging.returnado.com/public-api/v3/update-return-status/56367

 

Svar:

HTTP 200 hvis anmodningen er gennemført succesfuldt.

Fejlkoder hvor det er relevant:

For eksempel, hvis refundSucceeded mangler

 

{
  "code": 422,
  "error": "Unprocessable Entity",
  "message": "Field error in object 'returnOrderUpdateStatusDto' on field 'refundSucceeded': 
   rejected value [null]; codes [NotNull.returnOrderUpdateStatusDto.refundSucceeded,NotNull.
   refundSucceeded,NotNull.java.lang.Boolean,NotNull]; arguments [org.springframework.context
   .support.DefaultMessageSourceResolvable: codes [returnOrderUpdateStatusDto.refundSucceeded,
   refundSucceeded]; arguments []; default message [refundSucceeded]]; default message [must 
   not be null]",
  "timestamp": "2023-01-16T17:22:05Z"
}

 

Relaterede artikler