Returns endpoints

Get returns config

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns the current return configuration for the tenant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Return config found.

application/json

LocalizedReturnConfiguration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/configurations/return

GET /api/configurations/return HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "allowTriggerRefund": false,
  "availableItemConditions": [],
  "availableReturnReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Beschädigt",
        "en_US": "Damaged"
      },
      "identifier": "A"
    }
  ],
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Create return note

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

localestringOptional

Provide the localized values for the return note. If not provided the default locale is used. For example de_DE.

Body

ReturnNote

qrCodeContentstringOptional

Responses

201

Successfully created the return note.

application/pdf

401

Your user is not allowed to operate against this API instance

application/pdf

403

Your user, although recognized, is not authorized to use this endpoint

application/pdf

post

/api/returnnotes

POST /api/returnnotes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 744

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": 1,
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  },
  "qrCodeContent": "text"
}

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": 1,
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  },
  "qrCodeContent": "text"
}

Call item return action

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Applies an action to an Item Return. Check ItemReturnActionsParameters for available actions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

id of the Item Return Job

itemReturnIdstringRequired

id of the Item Return

Body

ItemReturnActionsParameter

Responses

200

Updated entity

application/json

ItemReturnJob

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

post

/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions

POST /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "itemReturnJobVersion": 1,
  "name": "AnnounceItemReturn"
}

{
  "anonymized": false,
  "consumerAddresses": [
    {
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr."
    }
  ],
  "customAttributes": {},
  "id": "text",
  "itemReturns": [],
  "notReturnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "originFacilityRefs": [
    "text"
  ],
  "processRef": "text",
  "returnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "status": "OPEN",
  "tenantOrderId": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get return note config

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Return note config could be found in response body.

application/json

Return Note Configuration

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/configurations/returnnote

GET /api/configurations/returnnote HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "articleIdLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "articleTitleLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "disclaimer": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "disclaimerHeadline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "displayPageLabel": false,
  "headline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "id": "delivery-note",
  "logoUrl": "text",
  "orderDateLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "orderNumberLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "pageLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "pdfBackgroundConfiguration": {
    "firstPageBackgroundFileUrl": "text",
    "followingPageBackgroundFileUrl": "text"
  },
  "quantityLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonExplanation": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonExplanationHeadline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "substituteText": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update return note config

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ReturnNoteConfigurationForUpsert

displayPageLabelbooleanOptional

Determines if the page label should be shown

Default: false

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Responses

200

The return note configuration was successfully updated.

application/json

Return Note Configuration

201

The return note configuration was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

put

/api/configurations/returnnote

PUT /api/configurations/returnnote HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4378

{
  "articleIdLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "articleTitleLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "disclaimer": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "disclaimerHeadline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "displayPageLabel": false,
  "headline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "logo": {
    "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
    "name": "example.pdf"
  },
  "orderDateLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "orderNumberLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "pageLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "pdfBackgroundConfiguration": {
    "firstPageBackgroundFile": {
      "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
      "name": "example.pdf"
    },
    "followingPageBackgroundFile": {
      "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
      "name": "example.pdf"
    }
  },
  "quantityLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonExplanation": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonExplanationHeadline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "substituteText": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "version": 42
}

{
  "articleIdLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "articleTitleLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "disclaimer": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "disclaimerHeadline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "displayPageLabel": false,
  "headline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "id": "delivery-note",
  "logoUrl": "text",
  "orderDateLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "orderNumberLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "pageLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "pdfBackgroundConfiguration": {
    "firstPageBackgroundFileUrl": "text",
    "followingPageBackgroundFileUrl": "text"
  },
  "quantityLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonExplanation": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonExplanationHeadline": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "returnReasonLabel": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "substituteText": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get item return

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns a specific item return for a given item return job.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

item return job to read the item return for

itemReturnIdstringRequired

id of the item return you want to read

Query parameters

startAfterIdstringOptional

entity to start after

sizeintegerOptional

number of entities to show

Default: 25

Responses

200

Get a specific item return

application/json

ItemReturn

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

customAttributesobjectOptional

Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

idstringRequired

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

parcelRefsstring[]Optional

references the parcel

Example: 672f3f72-b5d3-47c7-941c-9af5348e3cd7

returnFacilityRefstringRequired

scannableCodesstring[]Optional

statusstring · enumRequired

ItemReturnStatus

Possible values:

tenantOrderIdstringOptional

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}

GET /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "parcelRefs": [
    "672f3f72-b5d3-47c7-941c-9af5348e3cd7"
  ],
  "returnedLineItems": [],
  "returnFacilityRef": "text",
  "scannableCodes": [
    "text"
  ],
  "status": "ANNOUNCED",
  "tenantOrderId": "text"
}

Update returned line items

put

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Replace returned line items of an item return of an item return job.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

id of the item return job the item return belongs to

itemReturnIdstringRequired

id of the item return the returned line items belong to

Body

ReplaceReturnedLineItems

itemReturnJobVersionintegerRequired

Version of the entity to be changed

Responses

200

The returned line items were successfully updated. Updated item return job is returned.

application/json

ItemReturnJob

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

409

Entity version conflict

application/json

put

/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems

PUT /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "itemReturnJobVersion": 1,
  "returnedLineItems": []
}

{
  "anonymized": false,
  "consumerAddresses": [
    {
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr."
    }
  ],
  "customAttributes": {},
  "id": "text",
  "itemReturns": [],
  "notReturnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "originFacilityRefs": [
    "text"
  ],
  "processRef": "text",
  "returnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "status": "OPEN",
  "tenantOrderId": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List item returns

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns the item returns for a given item return job.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

item return job to read the item return for

Query parameters

startAfterIdstringOptional

entity to start after

sizeintegerOptional

number of entities to show

Default: 25

Responses

200

Get all item returns for a given item return job

application/json

anyOptional

ItemReturn

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/itemreturnjobs/{itemReturnJobId}/itemreturns

GET /api/itemreturnjobs/{itemReturnJobId}/itemreturns HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Get item return job

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns an item return job with the provided id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

id of the item return job

Responses

200

Returns Item Return Job with the provided id

application/json

ItemReturnJob

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/itemreturnjobs/{itemReturnJobId}

GET /api/itemreturnjobs/{itemReturnJobId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "anonymized": false,
  "consumerAddresses": [
    {
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr."
    }
  ],
  "customAttributes": {},
  "id": "text",
  "itemReturns": [],
  "notReturnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "originFacilityRefs": [
    "text"
  ],
  "processRef": "text",
  "returnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "status": "OPEN",
  "tenantOrderId": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get item returns

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns the item returns matching the given parameters.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchTermstringOptional

Search term you want to get the corresponding item returns. Search will be performed on multiple fields, including return id, tenant order id, customer name, tenant article ids, artile titles

facilityRefsstring[]Optional

facilities to filter the results

itemReturnStatusstring[]Optional

ItemReturnStatus of an included ItemReturn to filter the results

itemReturnLineItemStatusstring[]Optional

ItemReturnLineItemStatus of an included itemReturnLineItem to filter the results

startAfterIdstringOptional

entity to start after

sizeintegerOptional

number of entities to show

Default: 25

anonymizedbooleanOptional

show anonymized entities or not

Default: false

orderBystringOptional

sorting for the results

Responses

200

All Item Returns matching the given parameters

application/json

anyOptional

ItemReturn

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

get

/api/itemreturns

GET /api/itemreturns HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Update returned line item

patch

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Patch for a ItemReturn LineItem. This is used to update the returned line item.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

id of the Item Return Job

itemReturnIdstringRequired

id of the Item Return

returnedLineItemIdstringRequired

id of the returnedLineItem

Body

ItemReturnLineItemForUpdate

itemReturnJobVersionnumberRequired

version of the overlaying itemReturnJob

Example: 42

statusstring · enumOptional

ItemReturnLineItemStatus

Possible values:

Responses

200

Updated ItemReturnJob

application/json

ItemReturnJob

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

patch

/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId}

PATCH /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "itemReturnJobVersion": 42,
  "refund": {
    "percent": 80.6,
    "price": {
      "currency": "EUR",
      "value": 20.55
    },
    "status": "OPEN"
  },
  "status": "OPEN"
}

{
  "anonymized": false,
  "consumerAddresses": [
    {
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr."
    }
  ],
  "customAttributes": {},
  "id": "text",
  "itemReturns": [],
  "notReturnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "originFacilityRefs": [
    "text"
  ],
  "processRef": "text",
  "returnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "status": "OPEN",
  "tenantOrderId": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Create item return

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Create a new item return for an item return job

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

Id of the item return job to create the item return for

Body

AddItemReturnToItemReturnJob

itemReturnJobVersionintegerRequired

Version of the itemReturnJob the itemReturn gets added to

Responses

200

ItemReturnJob containing the newly created item return

application/json

ItemReturnJob

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/itemreturnjobs/{itemReturnJobId}/itemreturns

POST /api/itemreturnjobs/{itemReturnJobId}/itemreturns HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "itemReturnForCreation": {
    "returnedLineItems": [],
    "returnFacilityRef": "text",
    "scannableCodes": [
      "text"
    ],
    "status": "ANNOUNCED"
  },
  "itemReturnJobVersion": 1
}

{
  "anonymized": false,
  "consumerAddresses": [
    {
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr."
    }
  ],
  "customAttributes": {},
  "id": "text",
  "itemReturns": [],
  "notReturnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "originFacilityRefs": [
    "text"
  ],
  "processRef": "text",
  "returnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "status": "OPEN",
  "tenantOrderId": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete item return

delete

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Delete an item return from an item return job

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

id of the item return job to delete the item return for

itemReturnIdstringRequired

id of the item return you want to delete

Query parameters

itemReturnJobVersionnumberRequired

version of the item return job to delete the item return for

Responses

200

item return was found and successfully deleted. Updated item return job is returned.

application/json

ItemReturn

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

customAttributesobjectOptional

Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

idstringRequired

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

parcelRefsstring[]Optional

references the parcel

Example: 672f3f72-b5d3-47c7-941c-9af5348e3cd7

returnFacilityRefstringRequired

scannableCodesstring[]Optional

statusstring · enumRequired

ItemReturnStatus

Possible values:

tenantOrderIdstringOptional

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

delete

/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}

DELETE /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}?itemReturnJobVersion=1 HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "parcelRefs": [
    "672f3f72-b5d3-47c7-941c-9af5348e3cd7"
  ],
  "returnedLineItems": [],
  "returnFacilityRef": "text",
  "scannableCodes": [
    "text"
  ],
  "status": "ANNOUNCED",
  "tenantOrderId": "text"
}

Get pack job return note

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the PackJob

Query parameters

localestringOptional

Provide the localized values for the delivery note. If not provided the default locale is used. For example de_DE.

Responses

200

Returns a return note for the packjob.

application/pdf

401

Your user is not allowed to operate against this API instance

application/pdf

403

Your user, although recognized, is not authorized to use this endpoint

application/pdf

404

Entity not found

application/pdf

get

/api/packjobs/{packJobId}/returnnote

GET /api/packjobs/{packJobId}/returnnote HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Get pick job return note

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickjobIdstringRequired

ID of the Pickjob

Responses

200

Returns a return note for the pickjob.

application/pdf

401

Your user is not allowed to operate against this API instance

application/pdf

403

Your user, although recognized, is not authorized to use this endpoint

application/pdf

404

Entity not found

application/pdf

get

/api/pickjobs/{pickjobId}/returnnote

GET /api/pickjobs/{pickjobId}/returnnote HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Create item return job

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Creates a new item return job.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ItemReturnJobForCreation

customAttributesobjectOptional

Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

originFacilityRefsstring[]Required

processRefstringOptional

scannableCodesstring[]Optional

shortIdstringOptional

A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.

Example: AS12

statusstring · enumRequired

ItemReturnJobStatus

Possible values:

tenantOrderIdstringOptional

Responses

200

Created entity

application/json

ItemReturnJob

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/itemreturnjobs

POST /api/itemreturnjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 506

{
  "consumerAddresses": [
    {
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr."
    }
  ],
  "customAttributes": {},
  "notReturnableLineItems": [],
  "originFacilityRefs": [
    "text"
  ],
  "processRef": "text",
  "returnableLineItems": [],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "status": "OPEN",
  "tenantOrderId": "text"
}

{
  "anonymized": false,
  "consumerAddresses": [
    {
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr."
    }
  ],
  "customAttributes": {},
  "id": "text",
  "itemReturns": [],
  "notReturnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "originFacilityRefs": [
    "text"
  ],
  "processRef": "text",
  "returnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "status": "OPEN",
  "tenantOrderId": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Create item return parcel

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns all parcels for an itemReturn.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

itemReturnJobId

itemReturnIdstringRequired

id of the itemReturn to create a parcel for

Body

ParcelForCreation

carrierProductstringOptional

Desired product of given carrier to choose when ordering a label

Example: EXPRESS

carrierRefstringOptional

references the carrier to be used for sending. Can not be set when creating a parcel for an existing shipment.

customAttributesobjectOptional

Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

customProductValuenumberOptional

Set this value if you want to overwrite the calculated product value of the parcel.

Example: 12.5

loadUnitRefsstring[]Optional

Reference to array of load unit Refs

productValuenumberOptional

Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This value is calculated from the items in the parcel.

Example: 12.5

productValueTypestring · enumOptional

ProductValueType

Example: INSURANCEPossible values:

shortIdstringOptionalExample: AA12-1

statusstring · enumOptional

ParcelStatus

Possible values:

tenantOrderIdstringOptional

Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.

Example: R456728546

tenantParcelIdstringOptional

Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel

Example: MY-PARCEL-12345

Responses

201

Create a parcel for an itemReturn

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

post

/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/parcels

POST /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/parcels HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4281

{
  "carrierInformation": {
    "shippingContainerNumber": "123456-ABC"
  },
  "carrierProduct": "EXPRESS",
  "carrierRef": "text",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "invoice": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "items": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-02T21:49:23.133Z",
    "startTime": "2026-03-02T21:49:23.133Z"
  },
  "productValue": 12.5,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shortId": "AA12-1",
  "status": "OPEN",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ]
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "carrierInformation": {
    "shippingContainerNumber": "123456-ABC"
  },
  "carrierProduct": "EXPRESS",
  "carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "documentsRef": "text",
  "facilityRef": "text",
  "id": "95EWrieX09OmeriXIUbb",
  "invoice": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "items": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "operativeProcessRef": "text",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-02T21:49:23.133Z",
    "startTime": "2026-03-02T21:49:23.133Z"
  },
  "postalCharges": {
    "currency": "EUR",
    "value": 15.5
  },
  "processRef": "text",
  "productValue": 1250,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shipmentRef": "95EWrieX09OmeriXIUbb",
  "shortId": "AA12-1",
  "status": "OPEN",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ]
}

Call item return job action

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Applies an action to an Item Return Job. Check ItemReturnJobActionsParameters for available actions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

itemReturnJobIdstringRequired

id of the Item Return Job

Body

ItemReturnJobActionsParameter

Responses

200

Updated entity

application/json

ItemReturnJob

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

post

/api/itemreturnjobs/{itemReturnJobId}/actions

POST /api/itemreturnjobs/{itemReturnJobId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "name": "StartItemReturnJob",
  "version": 1
}

{
  "anonymized": false,
  "consumerAddresses": [
    {
      "additionalAddressInfo": "to care of: Mrs. Müller",
      "city": "Langenfeld",
      "country": "DE",
      "customAttributes": {},
      "houseNumber": "42a",
      "phoneNumbers": [
        {
          "customAttributes": {},
          "label": "text",
          "type": "MOBILE",
          "value": "text"
        }
      ],
      "postalCode": "40764",
      "province": "NRW",
      "street": "Hauptstr."
    }
  ],
  "customAttributes": {},
  "id": "text",
  "itemReturns": [],
  "notReturnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "originFacilityRefs": [
    "text"
  ],
  "processRef": "text",
  "returnableLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "prices": [
          {
            "currency": "EUR",
            "pricePerUnit": 9.99
          }
        ]
      },
      "customAttributes": {},
      "delivered": "7",
      "globalLineItemId": "text",
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "serviceJobRefs": [
        "text"
      ]
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "shortId": "AS12",
  "status": "OPEN",
  "tenantOrderId": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update returns config

put

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Updates the return configuration for the tenant. If no configuration exists, it will be created.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ReturnConfiguration

Responses

200

The return configuration was successfully updated.

application/json

LocalizedReturnConfiguration

201

The return configuration was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

409

Entity version conflict

application/json

put

/api/configurations/return

PUT /api/configurations/return HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "allowTriggerRefund": false,
  "availableItemConditions": [],
  "availableReturnReasons": [],
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "allowTriggerRefund": false,
  "availableItemConditions": [],
  "availableReturnReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Beschädigt",
        "en_US": "Damaged"
      },
      "identifier": "A"
    }
  ],
  "returnTypeConfiguration": {
    "type": "RETURN"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get parcel return note

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parcelIdstringRequired

ID of parcel you want to retrieve returnNote for

Query parameters

localestringOptional

Provide the localized values for the returnNote. If not provided the default locale is used. For example de_DE.

Responses

200

Get delivery note as pdf.

application/pdf

ReturnNote

qrCodeContentstringOptional

401

Your user is not allowed to operate against this API instance

application/pdf

403

Your user, although recognized, is not authorized to use this endpoint

application/pdf

404

Parcel not found

application/pdf

get

/api/parcels/{parcelId}/returnnote

GET /api/parcels/{parcelId}/returnnote HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": 1,
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  },
  "qrCodeContent": "text"
}

Last updated 1 month ago

hashtagGet returns config

hashtagCreate return note

hashtagCall item return action

hashtagGet return note config

hashtagUpdate return note config

hashtagGet item return

hashtagUpdate returned line items

hashtagList item returns

hashtagGet item return job

hashtagGet item returns

hashtagUpdate returned line item

hashtagCreate item return

hashtagDelete item return

hashtagGet pack job return note

hashtagGet pick job return note

hashtagCreate item return job

hashtagCreate item return parcel

hashtagCall item return job action

hashtagUpdate returns config

hashtagGet parcel return note

Get returns config

Create return note

Call item return action

Get return note config

Update return note config

Get item return

Update returned line items

List item returns

Get item return job

Get item returns

Update returned line item

Create item return

Delete item return

Get pack job return note

Get pick job return note

Create item return job

Create item return parcel

Call item return job action

Update returns config

Get parcel return note